yelpapi 2.6.0__tar.gz → 2.8.0__tar.gz

yelpapi-2.8.0/.github/workflows/publish.yml

@@ -0,0 +1,52 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+      contents: write
+
+    steps:
+      - uses: actions/checkout@v7
+
+      - name: Set up Python
+        uses: actions/setup-python@v7
+        with:
+          python-version: '3.15'
+
+      - name: Verify tag matches package version
+        run: |
+          version="$(python -c 'import tomllib; print(tomllib.load(open("pyproject.toml", "rb"))["project"]["version"])')"
+          if [ "v${version}" != "${GITHUB_REF_NAME}" ]; then
+            echo "Tag ${GITHUB_REF_NAME} does not match pyproject.toml version ${version}" >&2
+            exit 1
+          fi
+
+      - name: Extract release notes from CHANGES.md
+        run: |
+          version="${GITHUB_REF_NAME#v}"
+          awk -v v="$version" '/^## /{if (f) exit; f = (index($0, "## " v " ") == 1); next} f' CHANGES.md > release-notes.md
+          if [ ! -s release-notes.md ]; then
+            echo "No CHANGES.md entry found for ${version}" >&2
+            exit 1
+          fi
+
+      - name: Build
+        run: |
+          pip install build
+          python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+      - name: Create GitHub release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: gh release create "${GITHUB_REF_NAME}" dist/* --title "YelpAPI ${GITHUB_REF_NAME}" --notes-file release-notes.md

yelpapi-2.8.0/.github/workflows/tests.yml

@@ -0,0 +1,74 @@
+name: Tests
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+
+permissions:
+  contents: read
+
+# Cancel an in-progress run when a newer commit is pushed to the same branch or pull request.
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v7
+
+      # Ruff targets requires-python in pyproject.toml regardless of the interpreter it runs on.
+      - name: Set up Python
+        uses: actions/setup-python@v7
+        with:
+          python-version: '3.x'
+
+      - name: Install ruff
+        run: pip install ruff
+
+      - name: Lint with ruff
+        run: ruff check --output-format=github
+
+  typecheck:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v7
+
+      # mypy targets python_version in pyproject.toml regardless of the interpreter it runs on, so a single job is
+      # sufficient. Run it on that same minimum version so installed dependencies and stubs match what users on the
+      # minimum get. Keep this equal to python_version.
+      - name: Set up Python
+        uses: actions/setup-python@v7
+        with:
+          python-version: '3.11'
+
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Type-check with mypy
+        run: mypy
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ['3.11', '3.12', '3.13', '3.14', '3.15']
+
+    steps:
+      - uses: actions/checkout@v7
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v7
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: pip install -e ".[dev]"
+
+      - name: Run tests
+        run: pytest

{yelpapi-2.6.0 → yelpapi-2.8.0}/.gitignore

@@ -19,6 +19,7 @@ venv/
 .pytest_cache/
 .coverage
 htmlcov/
+.codebase-memory/
 
 # OS
 .DS_Store

yelpapi-2.8.0/AGENTS.md

@@ -0,0 +1,84 @@
+# AGENTS.md
+
+This file provides guidance to AI coding agents working with code in this repository.
+
+## Commands
+
+Install dependencies:
+```
+pip install -e ".[dev]"
+```
+
+Run tests (coverage included by default via `pyproject.toml`):
+```
+pytest
+```
+
+Run a single test:
+```
+pytest tests/test_yelpapi.py::TestYelpAPI::test_calls_api
+```
+
+Type-check (strict; configured in `[tool.mypy]` in `pyproject.toml`, which sets the files to check and targets the minimum supported Python):
+```
+mypy
+```
+
+Lint (configured in `[tool.ruff]` in `pyproject.toml`; `ruff check --fix` applies safe fixes):
+```
+ruff check
+```
+
+CI (`.github/workflows/tests.yml`) runs `pytest` on every supported Python version, plus `mypy` and `ruff check` once each in separate `typecheck` and `lint` jobs. All must pass.
+
+## Architecture
+
+This is a thin Python wrapper around Yelp's public REST APIs: the [Yelp Places API](https://docs.developer.yelp.com/docs/places-intro), the [Yelp AI API](https://docs.developer.yelp.com/docs/yelp-ai-api), [Yelp Insights](https://docs.developer.yelp.com/docs/yelp-insights), and the [Home Services API](https://docs.developer.yelp.com/docs/home-services-api). The entire implementation lives in `yelpapi/yelpapi.py` as a single `YelpAPI` class, re-exported from `yelpapi/__init__.py` via `__all__`.
+
+**Design philosophy:** The wrapper is intentionally minimal and extensible — all API parameters are passed through `**kwargs` directly to the HTTP request, so it doesn't break when Yelp adds new parameters. The only thing that would break it is a URL scheme change. Public methods return `dict[str, Any]`; don't introduce `TypedDict`s or response models, since they would break this pass-through design.
+
+**Request flow:** Each public method (e.g., `search_query`, `business_query`) validates required parameters, then delegates to `_get()` (GET; kwargs become query string parameters) or `_post()` (POST; kwargs become the JSON body). Both strip `None`-valued kwargs before issuing the request via a shared `requests.Session`, then hand the response to `_parse_response()`, which raises `requests.HTTPError` for HTTP error statuses, returns `{}` for empty `202`/`204` responses, and raises `YelpAPI.YelpAPIError` if the JSON body isn't an object or contains an `error` key. Methods that require a location share a `_require_location_or_lat_lng()` helper.
+
+**Session management:** A single `requests.Session` is reused for all calls (performance benefit). Users should close it via context manager (`with YelpAPI(...) as api`) or explicitly via `api.close()`.
+
+**Tests** use `requests-mock` (via the `mock_request` autouse fixture in `conftest.py`) to intercept HTTP calls, and a fixed-seed `Faker` for generating test data, so every run is deterministic. No real API calls are made in tests.
+
+## Conventions
+
+- **Typing:** The package ships `py.typed` and must pass strict `mypy`. All library code must be fully annotated. Tests and examples are type-checked but may omit annotations; see the `[[tool.mypy.overrides]]` section of `pyproject.toml`.
+- **Coverage:** Line coverage of `yelpapi/` is 100%. Keep it there; new code paths need tests.
+- **Style:** Use single quotes for strings, and 120-character lines.
+- **Adding an endpoint** requires all of the following:
+  - a `*_API_URL` constant
+  - a method that validates required parameters and calls `_get()` (GET) or `_post()` (POST); path parameters are positional arguments inserted with `quote(value, safe='')`
+  - an entry in the `GET_ENDPOINTS` or `POST_ENDPOINTS` table in `tests/test_yelpapi.py` (use `PATH_PARAM` for path parameters)
+  - an entry in the `YelpAPI` class docstring's API list
+  - an entry in the README "METHODS" list
+  - tests covering both validation failures and success
+
+## Supported Python versions
+
+Support only Python versions that are currently maintained (not end-of-life); see https://devguide.python.org/versions/. The minimum is currently 3.11. When adding or dropping a version, update all of these together:
+
+- `requires-python` and the `Programming Language :: Python :: 3.x` classifiers in `pyproject.toml`
+- `python_version` in `[tool.mypy]` in `pyproject.toml` (keep it equal to the minimum)
+- the `test` job's matrix in `.github/workflows/tests.yml`
+- the Python version used by the `typecheck` job in `tests.yml` (keep it equal to the minimum, matching `python_version`)
+- the Python version used by `publish.yml` (use the newest supported version)
+- the "REQUIREMENTS" section of `README.md`
+- `CHANGES.md`
+
+Once the minimum is raised, newly available language and typing features (e.g., `typing.Self` with 3.11) may be used.
+
+## Releasing
+
+1. Bump `version` in `pyproject.toml`.
+2. Add a `## X.Y.Z (YYYY-MM-DD)` entry at the top of `CHANGES.md`.
+3. Commit, push, and make sure CI is green. The publish workflow does not run tests.
+4. Push an annotated tag:
+
+   ```
+   git tag -a vX.Y.Z -m "vX.Y.Z" && git push origin vX.Y.Z
+   ```
+
+Pushing a `v*` tag triggers `.github/workflows/publish.yml`. Before publishing, it fails if the tag doesn't match the `pyproject.toml` version, or if `CHANGES.md` has no entry for that version. It then builds, publishes to PyPI, and creates a GitHub release whose notes are that version's `CHANGES.md` entry.

{yelpapi-2.6.0 → yelpapi-2.8.0}/CHANGES.md

@@ -1,5 +1,30 @@
 # Changes
 
+## 2.8.0 (2026-10-28)
+* **Heads up for subclassers:** the private request helper `YelpAPI._query()` has been renamed to `YelpAPI._get()`, and the new POST helper is `YelpAPI._post()`.
+    * If your subclass *calls* `self._query(...)` to reach endpoints this library doesn't wrap, switch to `self._get(...)`. `_query()` still works for this release but emits a `FutureWarning`.
+    * If your subclass *overrides* `_query()` (e.g., for caching, retries, or logging), override `_get()` (and `_post()` for POST endpoints) instead. Public methods no longer call `_query()`, so an override of it is no longer used. Defining such a subclass emits a `FutureWarning`.
+    * `_query()` will be removed in 2.9.0.
+* Added 8 new API endpoints: AI Chat (`ai_chat_query`), Business Insights (`business_insights_query`), Business Food & Drinks Insights (`business_food_and_drinks_insights_query`), Business Risk Signal Insights (`business_risk_signals_insights_query`), Business Request a Phone Call (`business_rapc_enabledness_query`), Jobs (`jobs_query`), Job Survey (`job_survey_query`), and Request a Quote (`request_a_quote_query`).
+* Added support for POST endpoints, which send `**kwargs` as the JSON request body (with `None` values removed). Successful responses with no body (e.g., `202 Accepted`) return an empty dict.
+* `business_service_offerings_query` now emits a `DeprecationWarning`, because Yelp has deprecated the endpoint in favor of "Jobs offered" on the Business API.
+* Fixed: a latitude or longitude of `0` (the equator or prime meridian) is now accepted by `search_query`, `featured_event_query`, and `transaction_search_query` instead of raising `ValueError`.
+* Fixed: `business_match_query` now accepts an empty `address1`, which Yelp allows for service businesses with no street address.
+* Fixed: a malformed `error` object in a response (e.g., a plain string, or one missing `code` or `description`) now raises `YelpAPI.YelpAPIError` instead of a `TypeError` or `KeyError`.
+* Path parameters (business IDs, aliases, event IDs, job aliases, and transaction types) are now percent-encoded, so characters like `/`, `?`, and `#` can no longer change the URL that is requested.
+* Clarified the `YelpAPI.YelpAPIError` docs: HTTP error statuses raise `requests.HTTPError`, while `YelpAPIError` covers error objects and non-object bodies in successful responses.
+* Updated docstrings to match Yelp's current docs (plan and access requirements, `match_threshold`, the 20-ID limit for `business_ids`, and required fields for Request a Quote).
+* Fixed the examples so they catch `requests.HTTPError` and keep going when an endpoint needs a paid plan or extra access.
+* Strengthened the test suite: every endpoint's URL, HTTP method, and parameters are now checked, and test data is deterministic.
+* Added [Ruff](https://docs.astral.sh/ruff/) linting, run in CI.
+
+## 2.7.0 (2026-10-28)
+* Dropped support for end-of-life Python 3.9 and 3.10; added Python 3.15. Minimum supported version is now 3.11.
+* `YelpAPI.__enter__` now returns `Self`, so subclasses are typed correctly when used as context managers.
+* Declared `__all__` in the `yelpapi` package so `from yelpapi import YelpAPI` passes `mypy --strict` (no implicit re-export) and Pyright's private-import checks.
+* Added the `Typing :: Typed` classifier.
+* A JSON response body that isn't an object (e.g., a string or list) now raises `YelpAPI.YelpAPIError` instead of an unhelpful `TypeError` or silently returning the wrong type.
+
 ## 2.6.0 (2026-03-17)
 * Added 5 new API endpoints: Business Engagement Metrics (`business_engagement_query`), Business Service Offerings (`business_service_offerings_query`), Categories (`categories_query`), Category by Alias (`category_query`), and Review Highlights (`review_highlights_query`).
 * Updated all documentation URLs to the current `docs.developer.yelp.com` reference format.

{yelpapi-2.6.0 → yelpapi-2.8.0}/PKG-INFO

@@ -1,7 +1,7 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: yelpapi
-Version: 2.6.0
-Summary: yelpapi is a pure Python implementation of the Yelp Fusion API.
+Version: 2.8.0
+Summary: yelpapi is a pure Python implementation of Yelp's public REST APIs (Places, AI, Insights, and Home Services).
 Project-URL: Homepage, https://github.com/lanl/yelpapi
 Project-URL: Changelog, https://github.com/lanl/yelpapi/blob/master/CHANGES.md
 Author-email: Geoffrey Fairchild <mail@gfairchild.com>
@@ -32,21 +32,25 @@ Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: BSD License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
 Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.9
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
 Requires-Dist: requests
 Provides-Extra: dev
 Requires-Dist: faker; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
 Requires-Dist: pytest; extra == 'dev'
 Requires-Dist: pytest-cov; extra == 'dev'
 Requires-Dist: requests-mock; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Requires-Dist: types-requests; extra == 'dev'
 Description-Content-Type: text/markdown
 
 # yelpapi
@@ -54,18 +58,18 @@ Description-Content-Type: text/markdown
 [![Tests](https://github.com/lanl/yelpapi/actions/workflows/tests.yml/badge.svg)](https://github.com/lanl/yelpapi/actions/workflows/tests.yml)
 
 ## LICENSE
-This software is licensed under the [BSD 3-Clause License](http://opensource.org/licenses/BSD-3-Clause). Please refer to the separate [LICENSE](LICENSE) file for the exact text of the license. You are obligated to give attribution if you use this code.
+This software is licensed under the [BSD 3-Clause License](https://opensource.org/licenses/BSD-3-Clause). Please refer to the separate [LICENSE](LICENSE) file for the exact text of the license. You are obligated to give attribution if you use this code.
 
 ## ABOUT
-yelpapi is a pure Python implementation of the [Yelp Fusion API](https://docs.developer.yelp.com/docs/fusion-intro). It is simple, fast, and robust to any changes Yelp may make to the API in the future.
+yelpapi is a pure Python implementation of Yelp's public REST APIs, including the [Yelp Places API](https://docs.developer.yelp.com/docs/places-intro), the [Yelp AI API](https://docs.developer.yelp.com/docs/yelp-ai-api), [Yelp Insights](https://docs.developer.yelp.com/docs/yelp-insights), and the [Home Services API](https://docs.developer.yelp.com/docs/home-services-api). It is simple, fast, and robust to any changes Yelp may make to its APIs in the future.
 
 ## REQUIREMENTS
-This code requires Python 3.9 or higher and [requests](https://github.com/requests/requests).
+This code requires Python 3.11 or higher and [requests](https://github.com/psf/requests).
 
 ## INSTALL
 yelpapi is available on PyPI at https://pypi.org/project/yelpapi/.
 
-Install using [pip](http://www.pip-installer.org/):
+Install using [pip](https://pip.pypa.io/):
 
     pip install yelpapi
 
@@ -75,7 +79,7 @@ This API is demonstrated more thoroughly in [examples.py](examples/examples.py),
 ```python
 from yelpapi import YelpAPI
 with YelpAPI(api_key) as yelp_api:
-    search_results = yelp_api.search_query(args)
+    search_results = yelp_api.search_query(term='ice cream', location='austin, tx')
 ```
 
 You can also set timeouts so API calls do not block indefinitely in degraded network conditions:
@@ -83,33 +87,43 @@ You can also set timeouts so API calls do not block indefinitely in degraded net
 ```python
 from yelpapi import YelpAPI
 with YelpAPI(api_key, timeout_s=3.0) as yelp_api:
-    search_results = yelp_api.search_query(args)
+    search_results = yelp_api.search_query(term='ice cream', location='austin, tx')
 ```
 
 Under the covers, this module uses a [`requests.Session`](https://requests.readthedocs.io/en/latest/user/advanced/#session-objects) object for issuing all API calls, which offers potentially significant performance benefits over issuing separate API calls outside of a session. You should be sure to close the underlying session when all API interactions are complete. The above examples demonstrate using the class as a context manager, which will automatically close the connection when you're done and is the preferred way of using the class, but you can also manually close it like this if a context manager won't work for your use case:
 
 ```python
 from yelpapi import YelpAPI
+yelp_api = YelpAPI(api_key)
 try:
-    yelp_api = YelpAPI(api_key)
-    search_results = yelp_api.search_query(args)
+    search_results = yelp_api.search_query(term='ice cream', location='austin, tx')
 finally:
     yelp_api.close()
 ```
 
 ## METHODS
+* [AI Chat API](https://docs.developer.yelp.com/reference/v2_ai_chat) - `ai_chat_query(...)`
 * [Autocomplete API](https://docs.developer.yelp.com/reference/v3_autocomplete) - `autocomplete_query(...)`
 * [Business API](https://docs.developer.yelp.com/reference/v3_business_info) - `business_query(...)`
 * [Business Engagement Metrics API](https://docs.developer.yelp.com/reference/v3_get_businesses_engagement) - `business_engagement_query(...)`
+* [Business Food & Drinks Insights API](https://docs.developer.yelp.com/reference/v3_get_business_food_and_drinks_insights) - `business_food_and_drinks_insights_query(...)`
+* [Business Insights API](https://docs.developer.yelp.com/reference/v3_businesses_insights) - `business_insights_query(...)`
 * [Business Match API](https://docs.developer.yelp.com/reference/v3_business_match) - `business_match_query(...)`
-* [Business Service Offerings API](https://docs.developer.yelp.com/reference/v3_business_service_offerings) - `business_service_offerings_query(...)`
+* [Business Request a Phone Call API](https://docs.developer.yelp.com/reference/v3_business_rapc_enabledness) - `business_rapc_enabledness_query(...)`
+* [Business Risk Signal Insights API](https://docs.developer.yelp.com/reference/v3_get_business_risk_signals_insights) - `business_risk_signals_insights_query(...)`
+* [Business Service Offerings API](https://docs.developer.yelp.com/reference/v3_business_service_offerings) - `business_service_offerings_query(...)` (deprecated by Yelp in favor of "Jobs offered" on the Business API)
 * [Categories API](https://docs.developer.yelp.com/reference/v3_all_categories) - `categories_query(...)`
 * [Category API](https://docs.developer.yelp.com/reference/v3_categories) - `category_query(...)`
 * [Event Lookup API](https://docs.developer.yelp.com/reference/v3_event) - `event_lookup_query(...)`
 * [Event Search API](https://docs.developer.yelp.com/reference/v3_events_search) - `event_search_query(...)`
 * [Featured Event API](https://docs.developer.yelp.com/reference/v3_featured_event) - `featured_event_query(...)`
+* [Job Survey API](https://docs.developer.yelp.com/reference/v3_job_survey) - `job_survey_query(...)`
+* [Jobs API](https://docs.developer.yelp.com/reference/v3_get_jobs) - `jobs_query(...)`
 * [Phone Search API](https://docs.developer.yelp.com/reference/v3_business_phone_search) - `phone_search_query(...)`
+* [Request a Quote API](https://docs.developer.yelp.com/reference/v3_raq_submit_project) - `request_a_quote_query(...)`
 * [Review Highlights API](https://docs.developer.yelp.com/reference/v3_business_review_highlights) - `review_highlights_query(...)`
 * [Reviews API](https://docs.developer.yelp.com/reference/v3_business_reviews) - `reviews_query(...)`
 * [Search API](https://docs.developer.yelp.com/reference/v3_business_search) - `search_query(...)`
 * [Transaction Search API](https://docs.developer.yelp.com/reference/v3_transaction_search) - `transaction_search_query(...)`
+
+Yelp's [GraphQL API](https://docs.developer.yelp.com/docs/graphql-intro) is not wrapped, since it uses GraphQL queries rather than REST parameters.

{yelpapi-2.6.0 → yelpapi-2.8.0}/README.md

@@ -3,18 +3,18 @@
 [![Tests](https://github.com/lanl/yelpapi/actions/workflows/tests.yml/badge.svg)](https://github.com/lanl/yelpapi/actions/workflows/tests.yml)
 
 ## LICENSE
-This software is licensed under the [BSD 3-Clause License](http://opensource.org/licenses/BSD-3-Clause). Please refer to the separate [LICENSE](LICENSE) file for the exact text of the license. You are obligated to give attribution if you use this code.
+This software is licensed under the [BSD 3-Clause License](https://opensource.org/licenses/BSD-3-Clause). Please refer to the separate [LICENSE](LICENSE) file for the exact text of the license. You are obligated to give attribution if you use this code.
 
 ## ABOUT
-yelpapi is a pure Python implementation of the [Yelp Fusion API](https://docs.developer.yelp.com/docs/fusion-intro). It is simple, fast, and robust to any changes Yelp may make to the API in the future.
+yelpapi is a pure Python implementation of Yelp's public REST APIs, including the [Yelp Places API](https://docs.developer.yelp.com/docs/places-intro), the [Yelp AI API](https://docs.developer.yelp.com/docs/yelp-ai-api), [Yelp Insights](https://docs.developer.yelp.com/docs/yelp-insights), and the [Home Services API](https://docs.developer.yelp.com/docs/home-services-api). It is simple, fast, and robust to any changes Yelp may make to its APIs in the future.
 
 ## REQUIREMENTS
-This code requires Python 3.9 or higher and [requests](https://github.com/requests/requests).
+This code requires Python 3.11 or higher and [requests](https://github.com/psf/requests).
 
 ## INSTALL
 yelpapi is available on PyPI at https://pypi.org/project/yelpapi/.
 
-Install using [pip](http://www.pip-installer.org/):
+Install using [pip](https://pip.pypa.io/):
 
     pip install yelpapi
 
@@ -24,7 +24,7 @@ This API is demonstrated more thoroughly in [examples.py](examples/examples.py),
 ```python
 from yelpapi import YelpAPI
 with YelpAPI(api_key) as yelp_api:
-    search_results = yelp_api.search_query(args)
+    search_results = yelp_api.search_query(term='ice cream', location='austin, tx')
 ```
 
 You can also set timeouts so API calls do not block indefinitely in degraded network conditions:
@@ -32,33 +32,43 @@ You can also set timeouts so API calls do not block indefinitely in degraded net
 ```python
 from yelpapi import YelpAPI
 with YelpAPI(api_key, timeout_s=3.0) as yelp_api:
-    search_results = yelp_api.search_query(args)
+    search_results = yelp_api.search_query(term='ice cream', location='austin, tx')
 ```
 
 Under the covers, this module uses a [`requests.Session`](https://requests.readthedocs.io/en/latest/user/advanced/#session-objects) object for issuing all API calls, which offers potentially significant performance benefits over issuing separate API calls outside of a session. You should be sure to close the underlying session when all API interactions are complete. The above examples demonstrate using the class as a context manager, which will automatically close the connection when you're done and is the preferred way of using the class, but you can also manually close it like this if a context manager won't work for your use case:
 
 ```python
 from yelpapi import YelpAPI
+yelp_api = YelpAPI(api_key)
 try:
-    yelp_api = YelpAPI(api_key)
-    search_results = yelp_api.search_query(args)
+    search_results = yelp_api.search_query(term='ice cream', location='austin, tx')
 finally:
     yelp_api.close()
 ```
 
 ## METHODS
+* [AI Chat API](https://docs.developer.yelp.com/reference/v2_ai_chat) - `ai_chat_query(...)`
 * [Autocomplete API](https://docs.developer.yelp.com/reference/v3_autocomplete) - `autocomplete_query(...)`
 * [Business API](https://docs.developer.yelp.com/reference/v3_business_info) - `business_query(...)`
 * [Business Engagement Metrics API](https://docs.developer.yelp.com/reference/v3_get_businesses_engagement) - `business_engagement_query(...)`
+* [Business Food & Drinks Insights API](https://docs.developer.yelp.com/reference/v3_get_business_food_and_drinks_insights) - `business_food_and_drinks_insights_query(...)`
+* [Business Insights API](https://docs.developer.yelp.com/reference/v3_businesses_insights) - `business_insights_query(...)`
 * [Business Match API](https://docs.developer.yelp.com/reference/v3_business_match) - `business_match_query(...)`
-* [Business Service Offerings API](https://docs.developer.yelp.com/reference/v3_business_service_offerings) - `business_service_offerings_query(...)`
+* [Business Request a Phone Call API](https://docs.developer.yelp.com/reference/v3_business_rapc_enabledness) - `business_rapc_enabledness_query(...)`
+* [Business Risk Signal Insights API](https://docs.developer.yelp.com/reference/v3_get_business_risk_signals_insights) - `business_risk_signals_insights_query(...)`
+* [Business Service Offerings API](https://docs.developer.yelp.com/reference/v3_business_service_offerings) - `business_service_offerings_query(...)` (deprecated by Yelp in favor of "Jobs offered" on the Business API)
 * [Categories API](https://docs.developer.yelp.com/reference/v3_all_categories) - `categories_query(...)`
 * [Category API](https://docs.developer.yelp.com/reference/v3_categories) - `category_query(...)`
 * [Event Lookup API](https://docs.developer.yelp.com/reference/v3_event) - `event_lookup_query(...)`
 * [Event Search API](https://docs.developer.yelp.com/reference/v3_events_search) - `event_search_query(...)`
 * [Featured Event API](https://docs.developer.yelp.com/reference/v3_featured_event) - `featured_event_query(...)`
+* [Job Survey API](https://docs.developer.yelp.com/reference/v3_job_survey) - `job_survey_query(...)`
+* [Jobs API](https://docs.developer.yelp.com/reference/v3_get_jobs) - `jobs_query(...)`
 * [Phone Search API](https://docs.developer.yelp.com/reference/v3_business_phone_search) - `phone_search_query(...)`
+* [Request a Quote API](https://docs.developer.yelp.com/reference/v3_raq_submit_project) - `request_a_quote_query(...)`
 * [Review Highlights API](https://docs.developer.yelp.com/reference/v3_business_review_highlights) - `review_highlights_query(...)`
 * [Reviews API](https://docs.developer.yelp.com/reference/v3_business_reviews) - `reviews_query(...)`
 * [Search API](https://docs.developer.yelp.com/reference/v3_business_search) - `search_query(...)`
 * [Transaction Search API](https://docs.developer.yelp.com/reference/v3_transaction_search) - `transaction_search_query(...)`
+
+Yelp's [GraphQL API](https://docs.developer.yelp.com/docs/graphql-intro) is not wrapped, since it uses GraphQL queries rather than REST parameters.