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

Author: stainless-app[bot]

src/onebusaway/resources/agencies_with_coverage.py

@@ -22,10 +22,21 @@
 class AgenciesWithCoverageResource(SyncAPIResource):
     @cached_property
     def with_raw_response(self) -> AgenciesWithCoverageResourceWithRawResponse:
+        """
+        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/OneBusAway/python-sdk#accessing-raw-response-data-eg-headers
+        """
         return AgenciesWithCoverageResourceWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> AgenciesWithCoverageResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/OneBusAway/python-sdk#with_streaming_response
+        """
         return AgenciesWithCoverageResourceWithStreamingResponse(self)
 
     def list(
@@ -54,10 +65,21 @@ def list(
 class AsyncAgenciesWithCoverageResource(AsyncAPIResource):
     @cached_property
     def with_raw_response(self) -> AsyncAgenciesWithCoverageResourceWithRawResponse:
+        """
+        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/OneBusAway/python-sdk#accessing-raw-response-data-eg-headers
+        """
         return AsyncAgenciesWithCoverageResourceWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> AsyncAgenciesWithCoverageResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/OneBusAway/python-sdk#with_streaming_response
+        """
         return AsyncAgenciesWithCoverageResourceWithStreamingResponse(self)
 
     async def list(

src/onebusaway/resources/agency.py

@@ -22,10 +22,21 @@
 class AgencyResource(SyncAPIResource):
     @cached_property
     def with_raw_response(self) -> AgencyResourceWithRawResponse:
+        """
+        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/OneBusAway/python-sdk#accessing-raw-response-data-eg-headers
+        """
         return AgencyResourceWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> AgencyResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/OneBusAway/python-sdk#with_streaming_response
+        """
         return AgencyResourceWithStreamingResponse(self)
 
     def retrieve(
@@ -65,10 +76,21 @@ def retrieve(
 class AsyncAgencyResource(AsyncAPIResource):
     @cached_property
     def with_raw_response(self) -> AsyncAgencyResourceWithRawResponse:
+        """
+        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/OneBusAway/python-sdk#accessing-raw-response-data-eg-headers
+        """
         return AsyncAgencyResourceWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> AsyncAgencyResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/OneBusAway/python-sdk#with_streaming_response
+        """
         return AsyncAgencyResourceWithStreamingResponse(self)
 
     async def retrieve(

src/onebusaway/resources/arrival_and_departure.py

@@ -31,10 +31,21 @@
 class ArrivalAndDepartureResource(SyncAPIResource):
     @cached_property
     def with_raw_response(self) -> ArrivalAndDepartureResourceWithRawResponse:
+        """
+        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/OneBusAway/python-sdk#accessing-raw-response-data-eg-headers
+        """
         return ArrivalAndDepartureResourceWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> ArrivalAndDepartureResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/OneBusAway/python-sdk#with_streaming_response
+        """
         return ArrivalAndDepartureResourceWithStreamingResponse(self)
 
     def retrieve(
@@ -145,10 +156,21 @@ def list(
 class AsyncArrivalAndDepartureResource(AsyncAPIResource):
     @cached_property
     def with_raw_response(self) -> AsyncArrivalAndDepartureResourceWithRawResponse:
+        """
+        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/OneBusAway/python-sdk#accessing-raw-response-data-eg-headers
+        """
         return AsyncArrivalAndDepartureResourceWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> AsyncArrivalAndDepartureResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/OneBusAway/python-sdk#with_streaming_response
+        """
         return AsyncArrivalAndDepartureResourceWithStreamingResponse(self)
 
     async def retrieve(

src/onebusaway/resources/block.py

@@ -22,10 +22,21 @@
 class BlockResource(SyncAPIResource):
     @cached_property
     def with_raw_response(self) -> BlockResourceWithRawResponse:
+        """
+        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/OneBusAway/python-sdk#accessing-raw-response-data-eg-headers
+        """
         return BlockResourceWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> BlockResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/OneBusAway/python-sdk#with_streaming_response
+        """
         return BlockResourceWithStreamingResponse(self)
 
     def retrieve(
@@ -65,10 +76,21 @@ def retrieve(
 class AsyncBlockResource(AsyncAPIResource):
     @cached_property
     def with_raw_response(self) -> AsyncBlockResourceWithRawResponse:
+        """
+        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/OneBusAway/python-sdk#accessing-raw-response-data-eg-headers
+        """
         return AsyncBlockResourceWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> AsyncBlockResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/OneBusAway/python-sdk#with_streaming_response
+        """
         return AsyncBlockResourceWithStreamingResponse(self)
 
     async def retrieve(

src/onebusaway/resources/config.py

@@ -22,10 +22,21 @@
 class ConfigResource(SyncAPIResource):
     @cached_property
     def with_raw_response(self) -> ConfigResourceWithRawResponse:
+        """
+        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/OneBusAway/python-sdk#accessing-raw-response-data-eg-headers
+        """
         return ConfigResourceWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> ConfigResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/OneBusAway/python-sdk#with_streaming_response
+        """
         return ConfigResourceWithStreamingResponse(self)
 
     def retrieve(
@@ -51,10 +62,21 @@ def retrieve(
 class AsyncConfigResource(AsyncAPIResource):
     @cached_property
     def with_raw_response(self) -> AsyncConfigResourceWithRawResponse:
+        """
+        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/OneBusAway/python-sdk#accessing-raw-response-data-eg-headers
+        """
         return AsyncConfigResourceWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> AsyncConfigResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/OneBusAway/python-sdk#with_streaming_response
+        """
         return AsyncConfigResourceWithStreamingResponse(self)
 
     async def retrieve(

src/onebusaway/resources/current_time.py

@@ -22,10 +22,21 @@
 class CurrentTimeResource(SyncAPIResource):
     @cached_property
     def with_raw_response(self) -> CurrentTimeResourceWithRawResponse:
+        """
+        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/OneBusAway/python-sdk#accessing-raw-response-data-eg-headers
+        """
         return CurrentTimeResourceWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> CurrentTimeResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/OneBusAway/python-sdk#with_streaming_response
+        """
         return CurrentTimeResourceWithStreamingResponse(self)
 
     def retrieve(
@@ -51,10 +62,21 @@ def retrieve(
 class AsyncCurrentTimeResource(AsyncAPIResource):
     @cached_property
     def with_raw_response(self) -> AsyncCurrentTimeResourceWithRawResponse:
+        """
+        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/OneBusAway/python-sdk#accessing-raw-response-data-eg-headers
+        """
         return AsyncCurrentTimeResourceWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> AsyncCurrentTimeResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/OneBusAway/python-sdk#with_streaming_response
+        """
         return AsyncCurrentTimeResourceWithStreamingResponse(self)
 
     async def retrieve(

src/onebusaway/resources/report_problem_with_stop.py

@@ -29,10 +29,21 @@
 class ReportProblemWithStopResource(SyncAPIResource):
     @cached_property
     def with_raw_response(self) -> ReportProblemWithStopResourceWithRawResponse:
+        """
+        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/OneBusAway/python-sdk#accessing-raw-response-data-eg-headers
+        """
         return ReportProblemWithStopResourceWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> ReportProblemWithStopResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/OneBusAway/python-sdk#with_streaming_response
+        """
         return ReportProblemWithStopResourceWithStreamingResponse(self)
 
     def retrieve(
@@ -101,10 +112,21 @@ def retrieve(
 class AsyncReportProblemWithStopResource(AsyncAPIResource):
     @cached_property
     def with_raw_response(self) -> AsyncReportProblemWithStopResourceWithRawResponse:
+        """
+        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/OneBusAway/python-sdk#accessing-raw-response-data-eg-headers
+        """
         return AsyncReportProblemWithStopResourceWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> AsyncReportProblemWithStopResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/OneBusAway/python-sdk#with_streaming_response
+        """
         return AsyncReportProblemWithStopResourceWithStreamingResponse(self)
 
     async def retrieve(

src/onebusaway/resources/report_problem_with_trip.py

@@ -29,10 +29,21 @@
 class ReportProblemWithTripResource(SyncAPIResource):
     @cached_property
     def with_raw_response(self) -> ReportProblemWithTripResourceWithRawResponse:
+        """
+        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/OneBusAway/python-sdk#accessing-raw-response-data-eg-headers
+        """
         return ReportProblemWithTripResourceWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> ReportProblemWithTripResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/OneBusAway/python-sdk#with_streaming_response
+        """
         return ReportProblemWithTripResourceWithStreamingResponse(self)
 
     def retrieve(
@@ -128,10 +139,21 @@ def retrieve(
 class AsyncReportProblemWithTripResource(AsyncAPIResource):
     @cached_property
     def with_raw_response(self) -> AsyncReportProblemWithTripResourceWithRawResponse:
+        """
+        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/OneBusAway/python-sdk#accessing-raw-response-data-eg-headers
+        """
         return AsyncReportProblemWithTripResourceWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> AsyncReportProblemWithTripResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/OneBusAway/python-sdk#with_streaming_response
+        """
         return AsyncReportProblemWithTripResourceWithStreamingResponse(self)
 
     async def retrieve(

src/onebusaway/resources/route.py

@@ -22,10 +22,21 @@
 class RouteResource(SyncAPIResource):
     @cached_property
     def with_raw_response(self) -> RouteResourceWithRawResponse:
+        """
+        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/OneBusAway/python-sdk#accessing-raw-response-data-eg-headers
+        """
         return RouteResourceWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> RouteResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/OneBusAway/python-sdk#with_streaming_response
+        """
         return RouteResourceWithStreamingResponse(self)
 
     def retrieve(
@@ -65,10 +76,21 @@ def retrieve(
 class AsyncRouteResource(AsyncAPIResource):
     @cached_property
     def with_raw_response(self) -> AsyncRouteResourceWithRawResponse:
+        """
+        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/OneBusAway/python-sdk#accessing-raw-response-data-eg-headers
+        """
         return AsyncRouteResourceWithRawResponse(self)
 
     @cached_property
     def with_streaming_response(self) -> AsyncRouteResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/OneBusAway/python-sdk#with_streaming_response
+        """
         return AsyncRouteResourceWithStreamingResponse(self)
 
     async def retrieve(