feat(api): api update

.stats.yml

@@ -1,3 +1,3 @@
 configured_endpoints: 254
-openapi_spec_hash: 55fb271eb29805e8a49ed72fb5ed8843
+openapi_spec_hash: d641ea64d1228471a4e91126cebd8600
 config_hash: f0e1844d06c76a9e145f7986d993dda6

src/increase/resources/digital_card_profiles.py

@@ -179,7 +179,7 @@ def list(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> SyncPage[DigitalCardProfile]:
         """
-        List Card Profiles
+        List Digital Card Profiles
 
         Args:
           cursor: Return the page of entries after this one.
@@ -292,7 +292,7 @@ def clone(
         idempotency_key: str | None = None,
     ) -> DigitalCardProfile:
         """
-        Clones a Digital Card Profile
+        Clone a Digital Card Profile
 
         Args:
           digital_card_profile_id: The identifier of the Digital Card Profile to clone.
@@ -513,7 +513,7 @@ def list(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> AsyncPaginator[DigitalCardProfile, AsyncPage[DigitalCardProfile]]:
         """
-        List Card Profiles
+        List Digital Card Profiles
 
         Args:
           cursor: Return the page of entries after this one.
@@ -626,7 +626,7 @@ async def clone(
         idempotency_key: str | None = None,
     ) -> DigitalCardProfile:
         """
-        Clones a Digital Card Profile
+        Clone a Digital Card Profile
 
         Args:
           digital_card_profile_id: The identifier of the Digital Card Profile to clone.

src/increase/resources/files.py

@@ -189,8 +189,11 @@ def retrieve(
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> File:
-        """
-        Retrieve a File
+        """Fetch metadata about a File, like its `purpose` and MIME type.
+
+        To access the
+        content, use the [Get File contents](/documentation/api/files#get-file-contents)
+        API.
 
         Args:
           file_id: The identifier of the File.
@@ -474,8 +477,11 @@ async def retrieve(
         extra_body: Body | None = None,
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> File:
-        """
-        Retrieve a File
+        """Fetch metadata about a File, like its `purpose` and MIME type.
+
+        To access the
+        content, use the [Get File contents](/documentation/api/files#get-file-contents)
+        API.
 
         Args:
           file_id: The identifier of the File.

src/increase/resources/intrafi_account_enrollments.py

@@ -56,7 +56,7 @@ def create(
         idempotency_key: str | None = None,
     ) -> IntrafiAccountEnrollment:
         """
-        Enroll an account in the IntraFi deposit sweep network
+        Enroll an Account in the IntraFi deposit sweep network
 
         Args:
           account_id: The identifier for the account to be added to IntraFi.
@@ -208,7 +208,7 @@ def unenroll(
         idempotency_key: str | None = None,
     ) -> IntrafiAccountEnrollment:
         """
-        Unenroll an account from IntraFi
+        Unenroll an Account from IntraFi
 
         Args:
           intrafi_account_enrollment_id: The Identifier of the IntraFi Account Enrollment to remove from IntraFi.
@@ -277,7 +277,7 @@ async def create(
         idempotency_key: str | None = None,
     ) -> IntrafiAccountEnrollment:
         """
-        Enroll an account in the IntraFi deposit sweep network
+        Enroll an Account in the IntraFi deposit sweep network
 
         Args:
           account_id: The identifier for the account to be added to IntraFi.
@@ -429,7 +429,7 @@ async def unenroll(
         idempotency_key: str | None = None,
     ) -> IntrafiAccountEnrollment:
         """
-        Unenroll an account from IntraFi
+        Unenroll an Account from IntraFi
 
         Args:
           intrafi_account_enrollment_id: The Identifier of the IntraFi Account Enrollment to remove from IntraFi.

src/increase/resources/physical_card_profiles.py

@@ -129,7 +129,7 @@ def retrieve(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> PhysicalCardProfile:
         """
-        Retrieve a Card Profile
+        Retrieve a Physical Card Profile
 
         Args:
           physical_card_profile_id: The identifier of the Card Profile.
@@ -443,7 +443,7 @@ async def retrieve(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> PhysicalCardProfile:
         """
-        Retrieve a Card Profile
+        Retrieve a Physical Card Profile
 
         Args:
           physical_card_profile_id: The identifier of the Card Profile.

src/increase/resources/supplemental_documents.py

@@ -56,7 +56,7 @@ def create(
         idempotency_key: str | None = None,
     ) -> EntitySupplementalDocument:
         """
-        Create a supplemental document for an Entity
+        Create a Supplemental Document
 
         Args:
           entity_id: The identifier of the Entity to associate with the supplemental document.
@@ -107,7 +107,7 @@ def list(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> SyncPage[EntitySupplementalDocument]:
         """
-        List Entity Supplemental Document Submissions
+        List Supplemental Documents
 
         Args:
           entity_id: The identifier of the Entity to list supplemental documents for.
@@ -188,7 +188,7 @@ async def create(
         idempotency_key: str | None = None,
     ) -> EntitySupplementalDocument:
         """
-        Create a supplemental document for an Entity
+        Create a Supplemental Document
 
         Args:
           entity_id: The identifier of the Entity to associate with the supplemental document.
@@ -239,7 +239,7 @@ def list(
         timeout: float | httpx.Timeout | None | NotGiven = not_given,
     ) -> AsyncPaginator[EntitySupplementalDocument, AsyncPage[EntitySupplementalDocument]]:
         """
-        List Entity Supplemental Document Submissions
+        List Supplemental Documents
 
         Args:
           entity_id: The identifier of the Entity to list supplemental documents for.

src/increase/types/account_statement.py

@@ -59,16 +59,18 @@ class AccountStatement(BaseModel):
     """
     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the end
     of the period the Account Statement covers. The statement covers all
-    transactions up to, but not including this timestamp. Usually, this is the
-    beginning of the following month.
+    transactions up to, but not including this timestamp. Statement periods are
+    measured in UTC days, so this is usually midnight UTC on the first day of the
+    following month.
     """
 
     statement_period_start: datetime
     """
     The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the
     start of the period the Account Statement covers. This is the first moment of
-    the statement period and is inclusive. Usually, this is the beginning of the
-    month this statement covers.
+    the statement period and is inclusive. Statement periods are measured in UTC
+    days, so this is usually midnight UTC on the first day of the month this
+    statement covers.
     """
 
     type: Literal["account_statement"]

src/increase/types/export.py

@@ -44,7 +44,7 @@ class AccountStatementBai2(BaseModel):
     """Filter results by Account."""
 
     effective_date: Optional[date] = None
-    """The date for which to retrieve the balance."""
+    """The UTC date for which to retrieve the balance."""
 
     program_id: Optional[str] = None
     """Filter results by Program."""
@@ -83,7 +83,7 @@ class AccountVerificationLetter(BaseModel):
     """The Account Number to create a letter for."""
 
     balance_date: Optional[date] = None
-    """The date of the balance to include in the letter."""
+    """The UTC date of the balance to include in the letter."""
 
 
 class BalanceCsvCreatedAt(BaseModel):
@@ -119,10 +119,10 @@ class BookkeepingAccountBalanceCsv(BaseModel):
     """Filter results by Bookkeeping Account."""
 
     on_or_after_date: Optional[date] = None
-    """Filter balances to those on or after this date."""
+    """Filter balances to those on or after this UTC date."""
 
     on_or_before_date: Optional[date] = None
-    """Filter balances to those on or before this date."""
+    """Filter balances to those on or before this UTC date."""
 
 
 class DailyAccountBalanceCsv(BaseModel):
@@ -135,10 +135,10 @@ class DailyAccountBalanceCsv(BaseModel):
     """Filter results by Account."""
 
     on_or_after_date: Optional[date] = None
-    """Filter balances on or after this date."""
+    """Filter balances on or after this UTC date."""
 
     on_or_before_date: Optional[date] = None
-    """Filter balances on or before this date."""
+    """Filter balances on or before this UTC date."""
 
 
 class DashboardTableCsv(BaseModel):

src/increase/types/export_create_params.py

@@ -145,11 +145,11 @@ class AccountStatementBai2(TypedDict, total=False):
     """
 
     effective_date: Annotated[Union[str, date], PropertyInfo(format="iso8601")]
-    """The date to create a BAI2 report for.
+    """The UTC date to create a BAI2 report for.
 
-    If not provided, the current date will be used. The timezone is UTC. If the
-    current date is used, the report will include intraday balances, otherwise it
-    will include end-of-day balances for the provided date.
+    If not provided, the current date will be used. If the current date is used, the
+    report will include intraday balances, otherwise it will include end-of-day
+    balances for the provided date.
     """
 
     program_id: str
@@ -192,7 +192,10 @@ class AccountVerificationLetter(TypedDict, total=False):
     """The Account Number to create a letter for."""
 
     balance_date: Annotated[Union[str, date], PropertyInfo(format="iso8601")]
-    """The date of the balance to include in the letter. Defaults to the current date."""
+    """The UTC date of the balance to include in the letter.
+
+    Defaults to the current date.
+    """
 
 
 class BookkeepingAccountBalanceCsv(TypedDict, total=False):
@@ -208,10 +211,10 @@ class BookkeepingAccountBalanceCsv(TypedDict, total=False):
     """
 
     on_or_after_date: Annotated[Union[str, date], PropertyInfo(format="iso8601")]
-    """Filter exported Balances to those on or after this date."""
+    """Filter exported Balances to those on or after this UTC date."""
 
     on_or_before_date: Annotated[Union[str, date], PropertyInfo(format="iso8601")]
-    """Filter exported Balances to those on or before this date."""
+    """Filter exported Balances to those on or before this UTC date."""
 
 
 class DailyAccountBalanceCsv(TypedDict, total=False):
@@ -224,10 +227,10 @@ class DailyAccountBalanceCsv(TypedDict, total=False):
     """Filter exported Balances to the specified Account."""
 
     on_or_after_date: Annotated[Union[str, date], PropertyInfo(format="iso8601")]
-    """Filter exported Balances to those on or after this date."""
+    """Filter exported Balances to those on or after this UTC date."""
 
     on_or_before_date: Annotated[Union[str, date], PropertyInfo(format="iso8601")]
-    """Filter exported Balances to those on or before this date."""
+    """Filter exported Balances to those on or before this UTC date."""
 
 
 class EntityCsv(TypedDict, total=False):

src/increase/types/inbound_fednow_transfer.py

@@ -123,6 +123,9 @@ class InboundFednowTransfer(BaseModel):
     end_to_end_identification: Optional[str] = None
     """A free-form reference string set by the sender, to help identify the transfer."""
 
+    message_identification: str
+    """The FedNow network identification of the transfer."""
+
     status: Literal["pending_confirming", "timed_out", "confirmed", "declined", "requires_attention"]
     """The lifecycle status of the transfer.
 
@@ -141,7 +144,7 @@ class InboundFednowTransfer(BaseModel):
     """
 
     transaction_identification: Optional[str] = None
-    """The FedNow network identification of the transfer."""
+    """An optional identifier for the transfer set by the sending bank."""
 
     type: Literal["inbound_fednow_transfer"]
     """A constant representing the object's type.