feat(api): update via SDK Studio

Author: stainless-bot

.stats.yml

@@ -1,2 +1,2 @@
-configured_endpoints: 5
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/open-transit%2Fopen-transit-4cacd27681586a8a15ad9de8f9611cdc0f6c59282aa780518d0864b38528d0c4.yml
+configured_endpoints: 6
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/open-transit%2Fopen-transit-27b1f9e5b37005e5040a5dd1be219f28a16f7e3a334e1b7919766b12fe34b33b.yml

CONTRIBUTING.md

@@ -32,7 +32,7 @@ $ pip install -r requirements-dev.lock
 ## Modifying/Adding code
 
 Most of the SDK is generated code, and any modified code will be overridden on the next generation. The
-`src/onebusaway/lib/` and `examples/` directories are exceptions and will never be overridden.
+`src/open_transit/lib/` and `examples/` directories are exceptions and will never be overridden.
 
 ## Adding and running examples
 

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2024 One Bus Away
+   Copyright 2024 Open Transit
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -1,16 +1,16 @@
-# One Bus Away Python API library
+# Open Transit Python API library
 
-[![PyPI version](https://img.shields.io/pypi/v/onebusaway.svg)](https://pypi.org/project/onebusaway/)
+[![PyPI version](https://img.shields.io/pypi/v/open-transit.svg)](https://pypi.org/project/open-transit/)
 
-The One Bus Away Python library provides convenient access to the One Bus Away REST API from any Python 3.7+
+The Open Transit Python library provides convenient access to the Open Transit REST API from any Python 3.7+
 application. The library includes type definitions for all request params and response fields,
 and offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).
 
 It is generated with [Stainless](https://www.stainlessapi.com/).
 
 ## Documentation
 
-The REST API documentation can be found [on developer.onebusaway.org](https://developer.onebusaway.org). The full API of this library can be found in [api.md](api.md).
+The REST API documentation can be found [on docs.open-transit.com](https://docs.open-transit.com). The full API of this library can be found in [api.md](api.md).
 
 ## Installation
 
@@ -20,23 +20,23 @@ pip install git+ssh://git@github.com/stainless-sdks/open-transit-python.git
 ```
 
 > [!NOTE]
-> Once this package is [published to PyPI](https://app.stainlessapi.com/docs/guides/publish), this will become: `pip install --pre onebusaway`
+> Once this package is [published to PyPI](https://app.stainlessapi.com/docs/guides/publish), this will become: `pip install --pre open-transit`
 
 ## Usage
 
 The full API of this library can be found in [api.md](api.md).
 
 ```python
 import os
-from onebusaway import OneBusAway
+from open_transit import OpenTransit
 
-client = OneBusAway(
+client = OpenTransit(
     # This is the default and can be omitted
     api_key=os.environ.get("OPEN_TRANSIT_API_KEY"),
 )
 
-agencies_with_coverage_retrieve_response = client.agencies_with_coverage.retrieve()
-print(agencies_with_coverage_retrieve_response.code)
+config_retrieve_response = client.where.config.retrieve()
+print(config_retrieve_response.code)
 ```
 
 While you can provide an `api_key` keyword argument,
@@ -46,22 +46,22 @@ so that your API Key is not stored in source control.
 
 ## Async usage
 
-Simply import `AsyncOneBusAway` instead of `OneBusAway` and use `await` with each API call:
+Simply import `AsyncOpenTransit` instead of `OpenTransit` and use `await` with each API call:
 
 ```python
 import os
 import asyncio
-from onebusaway import AsyncOneBusAway
+from open_transit import AsyncOpenTransit
 
-client = AsyncOneBusAway(
+client = AsyncOpenTransit(
     # This is the default and can be omitted
     api_key=os.environ.get("OPEN_TRANSIT_API_KEY"),
 )
 
 
 async def main() -> None:
-    agencies_with_coverage_retrieve_response = await client.agencies_with_coverage.retrieve()
-    print(agencies_with_coverage_retrieve_response.code)
+    config_retrieve_response = await client.where.config.retrieve()
+    print(config_retrieve_response.code)
 
 
 asyncio.run(main())
@@ -80,27 +80,27 @@ Typed requests and responses provide autocomplete and documentation within your
 
 ## Handling errors
 
-When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `onebusaway.APIConnectionError` is raised.
+When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `open_transit.APIConnectionError` is raised.
 
 When the API returns a non-success status code (that is, 4xx or 5xx
-response), a subclass of `onebusaway.APIStatusError` is raised, containing `status_code` and `response` properties.
+response), a subclass of `open_transit.APIStatusError` is raised, containing `status_code` and `response` properties.
 
-All errors inherit from `onebusaway.APIError`.
+All errors inherit from `open_transit.APIError`.
 
 ```python
-import onebusaway
-from onebusaway import OneBusAway
+import open_transit
+from open_transit import OpenTransit
 
-client = OneBusAway()
+client = OpenTransit()
 
 try:
-    client.agencies_with_coverage.retrieve()
-except onebusaway.APIConnectionError as e:
+    client.where.config.retrieve()
+except open_transit.APIConnectionError as e:
     print("The server could not be reached")
     print(e.__cause__)  # an underlying Exception, likely raised within httpx.
-except onebusaway.RateLimitError as e:
+except open_transit.RateLimitError as e:
     print("A 429 status code was received; we should back off a bit.")
-except onebusaway.APIStatusError as e:
+except open_transit.APIStatusError as e:
     print("Another non-200-range status code was received")
     print(e.status_code)
     print(e.response)
@@ -128,16 +128,16 @@ Connection errors (for example, due to a network connectivity problem), 408 Requ
 You can use the `max_retries` option to configure or disable retry settings:
 
 ```python
-from onebusaway import OneBusAway
+from open_transit import OpenTransit
 
 # Configure the default for all requests:
-client = OneBusAway(
+client = OpenTransit(
     # default is 2
     max_retries=0,
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).agencies_with_coverage.retrieve()
+client.with_options(max_retries=5).where.config.retrieve()
 ```
 
 ### Timeouts
@@ -146,21 +146,21 @@ By default requests time out after 1 minute. You can configure this with a `time
 which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/#fine-tuning-the-configuration) object:
 
 ```python
-from onebusaway import OneBusAway
+from open_transit import OpenTransit
 
 # Configure the default for all requests:
-client = OneBusAway(
+client = OpenTransit(
     # 20 seconds (default is 1 minute)
     timeout=20.0,
 )
 
 # More granular control:
-client = OneBusAway(
+client = OpenTransit(
     timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
 )
 
 # Override per-request:
-client.with_options(timeout=5.0).agencies_with_coverage.retrieve()
+client.with_options(timeout=5.0).where.config.retrieve()
 ```
 
 On timeout, an `APITimeoutError` is thrown.
@@ -173,10 +173,10 @@ Note that requests that time out are [retried twice by default](#retries).
 
 We use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.
 
-You can enable logging by setting the environment variable `ONE_BUS_AWAY_LOG` to `debug`.
+You can enable logging by setting the environment variable `OPEN_TRANSIT_LOG` to `debug`.
 
 ```shell
-$ export ONE_BUS_AWAY_LOG=debug
+$ export OPEN_TRANSIT_LOG=debug
 ```
 
 ### How to tell whether `None` means `null` or missing
@@ -196,19 +196,19 @@ if response.my_field is None:
 The "raw" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,
 
 ```py
-from onebusaway import OneBusAway
+from open_transit import OpenTransit
 
-client = OneBusAway()
-response = client.agencies_with_coverage.with_raw_response.retrieve()
+client = OpenTransit()
+response = client.where.config.with_raw_response.retrieve()
 print(response.headers.get('X-My-Header'))
 
-agencies_with_coverage = response.parse()  # get the object that `agencies_with_coverage.retrieve()` would have returned
-print(agencies_with_coverage.code)
+config = response.parse()  # get the object that `where.config.retrieve()` would have returned
+print(config.code)
 ```
 
-These methods return an [`APIResponse`](https://github.com/stainless-sdks/open-transit-python/tree/main/src/onebusaway/_response.py) object.
+These methods return an [`APIResponse`](https://github.com/stainless-sdks/open-transit-python/tree/main/src/open_transit/_response.py) object.
 
-The async client returns an [`AsyncAPIResponse`](https://github.com/stainless-sdks/open-transit-python/tree/main/src/onebusaway/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
+The async client returns an [`AsyncAPIResponse`](https://github.com/stainless-sdks/open-transit-python/tree/main/src/open_transit/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
 
 #### `.with_streaming_response`
 
@@ -217,7 +217,7 @@ The above interface eagerly reads the full response body when you make the reque
 To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
 
 ```python
-with client.agencies_with_coverage.with_streaming_response.retrieve() as response:
+with client.where.config.with_streaming_response.retrieve() as response:
     print(response.headers.get("X-My-Header"))
 
     for line in response.iter_lines():
@@ -270,10 +270,10 @@ You can directly override the [httpx client](https://www.python-httpx.org/api/#c
 - Additional [advanced](https://www.python-httpx.org/advanced/#client-instances) functionality
 
 ```python
-from onebusaway import OneBusAway, DefaultHttpxClient
+from open_transit import OpenTransit, DefaultHttpxClient
 
-client = OneBusAway(
-    # Or use the `ONE_BUS_AWAY_BASE_URL` env var
+client = OpenTransit(
+    # Or use the `OPEN_TRANSIT_BASE_URL` env var
     base_url="http://my.test.server.example.com:8083",
     http_client=DefaultHttpxClient(
         proxies="http://my.test.proxy.example.com",

SECURITY.md

@@ -16,11 +16,11 @@ before making any information public.
 ## Reporting Non-SDK Related Security Issues
 
 If you encounter security issues that are not directly related to SDKs but pertain to the services
-or products provided by One Bus Away please follow the respective company's security reporting guidelines.
+or products provided by Open Transit please follow the respective company's security reporting guidelines.
 
-### One Bus Away Terms and Policies
+### Open Transit Terms and Policies
 
-Please contact info@onebusaway.org for any questions or concerns regarding security of our services.
+Please contact dev-feedback@open-transit.com for any questions or concerns regarding security of our services.
 
 ---
 

api.md

@@ -1,59 +1,75 @@
-# AgenciesWithCoverage
+# Where
+
+## AgenciesWithCoverage
 
 Types:
 
 ```python
-from onebusaway.types import AgenciesWithCoverageRetrieveResponse
+from open_transit.types.where import AgenciesWithCoverageListResponse
 ```
 
 Methods:
 
-- <code title="get /api/where/agencies-with-coverage.json">client.agencies_with_coverage.<a href="./src/onebusaway/resources/agencies_with_coverage.py">retrieve</a>() -> <a href="./src/onebusaway/types/agencies_with_coverage_retrieve_response.py">AgenciesWithCoverageRetrieveResponse</a></code>
+- <code title="get /api/where/agencies-with-coverage.json">client.where.agencies_with_coverage.<a href="./src/open_transit/resources/where/agencies_with_coverage.py">list</a>() -> <a href="./src/open_transit/types/where/agencies_with_coverage_list_response.py">AgenciesWithCoverageListResponse</a></code>
 
-# Config
+## Config
 
 Types:
 
 ```python
-from onebusaway.types import ConfigRetrieveResponse
+from open_transit.types.where import ConfigRetrieveResponse
 ```
 
 Methods:
 
-- <code title="get /api/where/config.json">client.config.<a href="./src/onebusaway/resources/config.py">retrieve</a>() -> <a href="./src/onebusaway/types/config_retrieve_response.py">ConfigRetrieveResponse</a></code>
+- <code title="get /api/where/config.json">client.where.config.<a href="./src/open_transit/resources/where/config.py">retrieve</a>() -> <a href="./src/open_transit/types/where/config_retrieve_response.py">ConfigRetrieveResponse</a></code>
 
-# CurrentTime
+## CurrentTime
 
 Types:
 
 ```python
-from onebusaway.types import CurrentTimeRetrieveResponse
+from open_transit.types.where import CurrentTimeRetrieveResponse
 ```
 
 Methods:
 
-- <code title="get /api/where/current-time.json">client.current_time.<a href="./src/onebusaway/resources/current_time.py">retrieve</a>() -> <a href="./src/onebusaway/types/current_time_retrieve_response.py">CurrentTimeRetrieveResponse</a></code>
+- <code title="get /api/where/current-time.json">client.where.current_time.<a href="./src/open_transit/resources/where/current_time.py">retrieve</a>() -> <a href="./src/open_transit/types/where/current_time_retrieve_response.py">CurrentTimeRetrieveResponse</a></code>
+
+## StopsForLocation
+
+Types:
+
+```python
+from open_transit.types.where import StopsForLocationListResponse
+```
+
+Methods:
+
+- <code title="get /api/where/stops-for-location.json">client.where.stops_for_location.<a href="./src/open_transit/resources/where/stops_for_location.py">list</a>(\*\*<a href="src/open_transit/types/where/stops_for_location_list_params.py">params</a>) -> <a href="./src/open_transit/types/where/stops_for_location_list_response.py">StopsForLocationListResponse</a></code>
+
+## Stop
 
-# StopsForLocation
+### ArrivalAndDeparture
 
 Types:
 
 ```python
-from onebusaway.types import StopsForLocationRetrieveResponse
+from open_transit.types.where.stop import ArrivalAndDepartureRetrieveResponse
 ```
 
 Methods:
 
-- <code title="get /api/where/stops-for-location.json">client.stops_for_location.<a href="./src/onebusaway/resources/stops_for_location.py">retrieve</a>(\*\*<a href="src/onebusaway/types/stops_for_location_retrieve_params.py">params</a>) -> <a href="./src/onebusaway/types/stops_for_location_retrieve_response.py">StopsForLocationRetrieveResponse</a></code>
+- <code title="get /api/where/arrival-and-departure-for-stop/{stopID}.json">client.where.stop.arrival_and_departure.<a href="./src/open_transit/resources/where/stop/arrival_and_departure.py">retrieve</a>(stop_id, \*\*<a href="src/open_transit/types/where/stop/arrival_and_departure_retrieve_params.py">params</a>) -> <a href="./src/open_transit/types/where/stop/arrival_and_departure_retrieve_response.py">ArrivalAndDepartureRetrieveResponse</a></code>
 
-# ArrivalsAndDeparturesForStop
+### ArrivalsAndDepartures
 
 Types:
 
 ```python
-from onebusaway.types import ArrivalsAndDeparturesForStopRetrieveResponse
+from open_transit.types.where.stop import ArrivalsAndDepartureListResponse
 ```
 
 Methods:
 
-- <code title="get /api/where/arrival-and-departure-for-stop/{stopID}.json">client.arrivals_and_departures_for_stop.<a href="./src/onebusaway/resources/arrivals_and_departures_for_stop.py">retrieve</a>(stop_id, \*\*<a href="src/onebusaway/types/arrivals_and_departures_for_stop_retrieve_params.py">params</a>) -> <a href="./src/onebusaway/types/arrivals_and_departures_for_stop_retrieve_response.py">ArrivalsAndDeparturesForStopRetrieveResponse</a></code>
+- <code title="get /api/where/arrivals-and-departures-for-stop/{stopID}.json">client.where.stop.arrivals_and_departures.<a href="./src/open_transit/resources/where/stop/arrivals_and_departures.py">list</a>(stop_id) -> <a href="./src/open_transit/types/where/stop/arrivals_and_departure_list_response.py">ArrivalsAndDepartureListResponse</a></code>

mypy.ini

@@ -5,7 +5,7 @@ show_error_codes = True
 # Exclude _files.py because mypy isn't smart enough to apply
 # the correct type narrowing and as this is an internal module
 # it's fine to just use Pyright.
-exclude = ^(src/onebusaway/_files\.py|_dev/.*\.py)$
+exclude = ^(src/open_transit/_files\.py|_dev/.*\.py)$
 
 strict_equality = True
 implicit_reexport = True