chore: add docstrings to raw response properties (#519)

Modern-Treasury · Sep 9, 2024 · d0f8b63 · d0f8b63
1 parent 751a5fa
commit d0f8b63
Show file tree

Hide file tree

Showing 42 changed files with 924 additions and 0 deletions.
diff --git a/src/modern_treasury/resources/account_collection_flows.py b/src/modern_treasury/resources/account_collection_flows.py
@@ -31,10 +31,21 @@
 class AccountCollectionFlows(SyncAPIResource):
     @cached_property
     def with_raw_response(self) -> AccountCollectionFlowsWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return the
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#accessing-raw-response-data-eg-headers
+        """
         return AccountCollectionFlowsWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> AccountCollectionFlowsWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#with_streaming_response
+        """
         return AccountCollectionFlowsWithStreamingResponse(self)
 
     def create(
@@ -245,10 +256,21 @@ def list(
 class AsyncAccountCollectionFlows(AsyncAPIResource):
     @cached_property
     def with_raw_response(self) -> AsyncAccountCollectionFlowsWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return the
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#accessing-raw-response-data-eg-headers
+        """
         return AsyncAccountCollectionFlowsWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> AsyncAccountCollectionFlowsWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#with_streaming_response
+        """
         return AsyncAccountCollectionFlowsWithStreamingResponse(self)
 
     async def create(

diff --git a/src/modern_treasury/resources/account_details.py b/src/modern_treasury/resources/account_details.py
@@ -28,10 +28,21 @@
 class AccountDetails(SyncAPIResource):
     @cached_property
     def with_raw_response(self) -> AccountDetailsWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return the
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#accessing-raw-response-data-eg-headers
+        """
         return AccountDetailsWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> AccountDetailsWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#with_streaming_response
+        """
         return AccountDetailsWithStreamingResponse(self)
 
     def create(
@@ -242,10 +253,21 @@ def delete(
 class AsyncAccountDetails(AsyncAPIResource):
     @cached_property
     def with_raw_response(self) -> AsyncAccountDetailsWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return the
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#accessing-raw-response-data-eg-headers
+        """
         return AsyncAccountDetailsWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> AsyncAccountDetailsWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#with_streaming_response
+        """
         return AsyncAccountDetailsWithStreamingResponse(self)
 
     async def create(

diff --git a/src/modern_treasury/resources/bulk_requests.py b/src/modern_treasury/resources/bulk_requests.py
@@ -27,10 +27,21 @@
 class BulkRequests(SyncAPIResource):
     @cached_property
     def with_raw_response(self) -> BulkRequestsWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return the
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#accessing-raw-response-data-eg-headers
+        """
         return BulkRequestsWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> BulkRequestsWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#with_streaming_response
+        """
         return BulkRequestsWithStreamingResponse(self)
 
     def create(
@@ -192,10 +203,21 @@ def list(
 class AsyncBulkRequests(AsyncAPIResource):
     @cached_property
     def with_raw_response(self) -> AsyncBulkRequestsWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return the
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#accessing-raw-response-data-eg-headers
+        """
         return AsyncBulkRequestsWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> AsyncBulkRequestsWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#with_streaming_response
+        """
         return AsyncBulkRequestsWithStreamingResponse(self)
 
     async def create(

diff --git a/src/modern_treasury/resources/bulk_results.py b/src/modern_treasury/resources/bulk_results.py
@@ -24,10 +24,21 @@
 class BulkResults(SyncAPIResource):
     @cached_property
     def with_raw_response(self) -> BulkResultsWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return the
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#accessing-raw-response-data-eg-headers
+        """
         return BulkResultsWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> BulkResultsWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#with_streaming_response
+        """
         return BulkResultsWithStreamingResponse(self)
 
     def retrieve(
@@ -134,10 +145,21 @@ def list(
 class AsyncBulkResults(AsyncAPIResource):
     @cached_property
     def with_raw_response(self) -> AsyncBulkResultsWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return the
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#accessing-raw-response-data-eg-headers
+        """
         return AsyncBulkResultsWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> AsyncBulkResultsWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#with_streaming_response
+        """
         return AsyncBulkResultsWithStreamingResponse(self)
 
     async def retrieve(

diff --git a/src/modern_treasury/resources/connection_legal_entities.py b/src/modern_treasury/resources/connection_legal_entities.py
@@ -31,10 +31,21 @@
 class ConnectionLegalEntities(SyncAPIResource):
     @cached_property
     def with_raw_response(self) -> ConnectionLegalEntitiesWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return the
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#accessing-raw-response-data-eg-headers
+        """
         return ConnectionLegalEntitiesWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> ConnectionLegalEntitiesWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#with_streaming_response
+        """
         return ConnectionLegalEntitiesWithStreamingResponse(self)
 
     def create(
@@ -223,10 +234,21 @@ def list(
 class AsyncConnectionLegalEntities(AsyncAPIResource):
     @cached_property
     def with_raw_response(self) -> AsyncConnectionLegalEntitiesWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return the
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#accessing-raw-response-data-eg-headers
+        """
         return AsyncConnectionLegalEntitiesWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> AsyncConnectionLegalEntitiesWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#with_streaming_response
+        """
         return AsyncConnectionLegalEntitiesWithStreamingResponse(self)
 
     async def create(

diff --git a/src/modern_treasury/resources/connections.py b/src/modern_treasury/resources/connections.py
@@ -23,10 +23,21 @@
 class Connections(SyncAPIResource):
     @cached_property
     def with_raw_response(self) -> ConnectionsWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return the
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#accessing-raw-response-data-eg-headers
+        """
         return ConnectionsWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> ConnectionsWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#with_streaming_response
+        """
         return ConnectionsWithStreamingResponse(self)
 
     def list(
@@ -84,10 +95,21 @@ def list(
 class AsyncConnections(AsyncAPIResource):
     @cached_property
     def with_raw_response(self) -> AsyncConnectionsWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return the
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#accessing-raw-response-data-eg-headers
+        """
         return AsyncConnectionsWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> AsyncConnectionsWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#with_streaming_response
+        """
         return AsyncConnectionsWithStreamingResponse(self)
 
     def list(

diff --git a/src/modern_treasury/resources/counterparties.py b/src/modern_treasury/resources/counterparties.py
@@ -35,10 +35,21 @@
 class Counterparties(SyncAPIResource):
     @cached_property
     def with_raw_response(self) -> CounterpartiesWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return the
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#accessing-raw-response-data-eg-headers
+        """
         return CounterpartiesWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> CounterpartiesWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#with_streaming_response
+        """
         return CounterpartiesWithStreamingResponse(self)
 
     def create(
@@ -451,10 +462,21 @@ def collect_account(
 class AsyncCounterparties(AsyncAPIResource):
     @cached_property
     def with_raw_response(self) -> AsyncCounterpartiesWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return the
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#accessing-raw-response-data-eg-headers
+        """
         return AsyncCounterpartiesWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> AsyncCounterpartiesWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#with_streaming_response
+        """
         return AsyncCounterpartiesWithStreamingResponse(self)
 
     async def create(

diff --git a/src/modern_treasury/resources/documents.py b/src/modern_treasury/resources/documents.py
@@ -29,10 +29,21 @@
 class Documents(SyncAPIResource):
     @cached_property
     def with_raw_response(self) -> DocumentsWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return the
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#accessing-raw-response-data-eg-headers
+        """
         return DocumentsWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> DocumentsWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#with_streaming_response
+        """
         return DocumentsWithStreamingResponse(self)
 
     def create(
@@ -212,10 +223,21 @@ def list(
 class AsyncDocuments(AsyncAPIResource):
     @cached_property
     def with_raw_response(self) -> AsyncDocumentsWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return the
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#accessing-raw-response-data-eg-headers
+        """
         return AsyncDocumentsWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> AsyncDocumentsWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#with_streaming_response
+        """
         return AsyncDocumentsWithStreamingResponse(self)
 
     async def create(

diff --git a/src/modern_treasury/resources/events.py b/src/modern_treasury/resources/events.py
@@ -24,10 +24,21 @@
 class Events(SyncAPIResource):
     @cached_property
     def with_raw_response(self) -> EventsWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return the
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#accessing-raw-response-data-eg-headers
+        """
         return EventsWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> EventsWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#with_streaming_response
+        """
         return EventsWithStreamingResponse(self)
 
     def retrieve(
@@ -124,10 +135,21 @@ def list(
 class AsyncEvents(AsyncAPIResource):
     @cached_property
     def with_raw_response(self) -> AsyncEventsWithRawResponse:
+        """
+        This property can be used as a prefix for any HTTP method call to return the
+        the raw response object instead of the parsed content.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#accessing-raw-response-data-eg-headers
+        """
         return AsyncEventsWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> AsyncEventsWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/Modern-Treasury/modern-treasury-python#with_streaming_response
+        """
         return AsyncEventsWithStreamingResponse(self)
 
     async def retrieve(