feat(api): api update (#1630)

Co-authored-by: increase-releases[bot] <285999079+increase-releases[bot]@users.noreply.github.com>

Author: increase-releases[bot]

.stats.yml

@@ -1,3 +1,3 @@
-configured_endpoints: 254
-openapi_spec_hash: 55fb271eb29805e8a49ed72fb5ed8843
-config_hash: f0e1844d06c76a9e145f7986d993dda6
+configured_endpoints: 255
+openapi_spec_hash: 0c2a6908b65af7107b19958604ff5cb8
+config_hash: de151ebd21a0bd391662389b310a8f49

api.md

@@ -63,6 +63,7 @@ Methods:
 - <code title="post /cards/{card_id}/create_details_iframe">client.cards.<a href="./src/increase/resources/cards.py">create_details_iframe</a>(card_id, \*\*<a href="src/increase/types/card_create_details_iframe_params.py">params</a>) -> <a href="./src/increase/types/card_iframe_url.py">CardIframeURL</a></code>
 - <code title="post /cards/{card_id}/create_details_token">client.cards.<a href="./src/increase/resources/cards.py">create_details_token</a>(card_id) -> <a href="./src/increase/types/card_details_token.py">CardDetailsToken</a></code>
 - <code title="get /cards/{card_id}/details">client.cards.<a href="./src/increase/resources/cards.py">details</a>(card_id) -> <a href="./src/increase/types/card_details.py">CardDetails</a></code>
+- <code title="post /cards/{card_id}/renew">client.cards.<a href="./src/increase/resources/cards.py">renew</a>(card_id) -> <a href="./src/increase/types/card.py">Card</a></code>
 - <code title="post /cards/{card_id}/update_pin">client.cards.<a href="./src/increase/resources/cards.py">update_pin</a>(card_id, \*\*<a href="src/increase/types/card_update_pin_params.py">params</a>) -> <a href="./src/increase/types/card_details.py">CardDetails</a></code>
 
 # CardPayments

scripts/mock

@@ -63,6 +63,7 @@ def create(
         description: str | Omit = omit,
         digital_wallet: card_create_params.DigitalWallet | Omit = omit,
         entity_id: str | Omit = omit,
+        replacement_for: card_create_params.ReplacementFor | 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,
@@ -95,6 +96,9 @@ def create(
           entity_id: The Entity the card belongs to. You only need to supply this in rare situations
               when the card is not for the Account holder.
 
+          replacement_for: Details about the Card this Card replaces. Supply this when issuing a new Card
+              to take over from an existing one. The replaced Card is not canceled.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -116,6 +120,7 @@ def create(
                     "description": description,
                     "digital_wallet": digital_wallet,
                     "entity_id": entity_id,
+                    "replacement_for": replacement_for,
                 },
                 card_create_params.CardCreateParams,
             ),
@@ -440,6 +445,53 @@ def details(
             cast_to=CardDetails,
         )
 
+    def renew(
+        self,
+        card_id: str,
+        *,
+        # 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,
+        idempotency_key: str | None = None,
+    ) -> Card:
+        """Renew a Card in place.
+
+        The Card keeps its identifier, card number, PIN, and
+        Physical Cards, and receives a new expiration date in the current month four
+        years from now along with a new verification code, which the Card's details will
+        return afterwards. Physical Cards that have already shipped keep working until
+        they are canceled.
+
+        Args:
+          card_id: The identifier of the Card to renew.
+
+          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
+
+          idempotency_key: Specify a custom idempotency key for this request
+        """
+        if not card_id:
+            raise ValueError(f"Expected a non-empty value for `card_id` but received {card_id!r}")
+        return self._post(
+            path_template("/cards/{card_id}/renew", card_id=card_id),
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                idempotency_key=idempotency_key,
+            ),
+            cast_to=Card,
+        )
+
     def update_pin(
         self,
         card_id: str,
@@ -517,6 +569,7 @@ async def create(
         description: str | Omit = omit,
         digital_wallet: card_create_params.DigitalWallet | Omit = omit,
         entity_id: str | Omit = omit,
+        replacement_for: card_create_params.ReplacementFor | 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,
@@ -549,6 +602,9 @@ async def create(
           entity_id: The Entity the card belongs to. You only need to supply this in rare situations
               when the card is not for the Account holder.
 
+          replacement_for: Details about the Card this Card replaces. Supply this when issuing a new Card
+              to take over from an existing one. The replaced Card is not canceled.
+
           extra_headers: Send extra headers
 
           extra_query: Add additional query parameters to the request
@@ -570,6 +626,7 @@ async def create(
                     "description": description,
                     "digital_wallet": digital_wallet,
                     "entity_id": entity_id,
+                    "replacement_for": replacement_for,
                 },
                 card_create_params.CardCreateParams,
             ),
@@ -894,6 +951,53 @@ async def details(
             cast_to=CardDetails,
         )
 
+    async def renew(
+        self,
+        card_id: str,
+        *,
+        # 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,
+        idempotency_key: str | None = None,
+    ) -> Card:
+        """Renew a Card in place.
+
+        The Card keeps its identifier, card number, PIN, and
+        Physical Cards, and receives a new expiration date in the current month four
+        years from now along with a new verification code, which the Card's details will
+        return afterwards. Physical Cards that have already shipped keep working until
+        they are canceled.
+
+        Args:
+          card_id: The identifier of the Card to renew.
+
+          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
+
+          idempotency_key: Specify a custom idempotency key for this request
+        """
+        if not card_id:
+            raise ValueError(f"Expected a non-empty value for `card_id` but received {card_id!r}")
+        return await self._post(
+            path_template("/cards/{card_id}/renew", card_id=card_id),
+            options=make_request_options(
+                extra_headers=extra_headers,
+                extra_query=extra_query,
+                extra_body=extra_body,
+                timeout=timeout,
+                idempotency_key=idempotency_key,
+            ),
+            cast_to=Card,
+        )
+
     async def update_pin(
         self,
         card_id: str,
@@ -966,6 +1070,9 @@ def __init__(self, cards: CardsResource) -> None:
         self.details = to_raw_response_wrapper(
             cards.details,
         )
+        self.renew = to_raw_response_wrapper(
+            cards.renew,
+        )
         self.update_pin = to_raw_response_wrapper(
             cards.update_pin,
         )
@@ -996,6 +1103,9 @@ def __init__(self, cards: AsyncCardsResource) -> None:
         self.details = async_to_raw_response_wrapper(
             cards.details,
         )
+        self.renew = async_to_raw_response_wrapper(
+            cards.renew,
+        )
         self.update_pin = async_to_raw_response_wrapper(
             cards.update_pin,
         )
@@ -1026,6 +1136,9 @@ def __init__(self, cards: CardsResource) -> None:
         self.details = to_streamed_response_wrapper(
             cards.details,
         )
+        self.renew = to_streamed_response_wrapper(
+            cards.renew,
+        )
         self.update_pin = to_streamed_response_wrapper(
             cards.update_pin,
         )
@@ -1056,6 +1169,9 @@ def __init__(self, cards: AsyncCardsResource) -> None:
         self.details = async_to_streamed_response_wrapper(
             cards.details,
         )
+        self.renew = async_to_streamed_response_wrapper(
+            cards.renew,
+        )
         self.update_pin = async_to_streamed_response_wrapper(
             cards.update_pin,
         )

src/increase/resources/cards.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/digital_card_profiles.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/files.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/intrafi_account_enrollments.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/physical_card_profiles.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/resources/supplemental_documents.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"]