Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

release: 3.0.0-beta.5 #157

Merged
merged 13 commits into from
Mar 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .release-please-manifest.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
{
".": "3.0.0-beta.4"
".": "3.0.0-beta.5"
}
2 changes: 1 addition & 1 deletion .stats.yml
Original file line number Diff line number Diff line change
@@ -1 +1 @@
configured_endpoints: 1288
configured_endpoints: 1290
19 changes: 19 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,24 @@
# Changelog

## 3.0.0-beta.5 (2024-03-22)

Full Changelog: [v3.0.0-beta.4...v3.0.0-beta.5](https://github.com/cloudflare/cloudflare-python/compare/v3.0.0-beta.4...v3.0.0-beta.5)

### Features

* **api:** OpenAPI spec update via Stainless API ([#160](https://github.com/cloudflare/cloudflare-python/issues/160)) ([643c8ba](https://github.com/cloudflare/cloudflare-python/commit/643c8ba84324e07b43eb93fe62b1838bf1ff2abf))
* **api:** OpenAPI spec update via Stainless API ([#161](https://github.com/cloudflare/cloudflare-python/issues/161)) ([df27c86](https://github.com/cloudflare/cloudflare-python/commit/df27c862c5679893d137f93a40ff311c8dab379f))
* **api:** OpenAPI spec update via Stainless API ([#162](https://github.com/cloudflare/cloudflare-python/issues/162)) ([0798a30](https://github.com/cloudflare/cloudflare-python/commit/0798a30695a05d5b0287f09e50c340d916ceb8c1))
* **api:** OpenAPI spec update via Stainless API ([#163](https://github.com/cloudflare/cloudflare-python/issues/163)) ([6fed697](https://github.com/cloudflare/cloudflare-python/commit/6fed697d19f554b1da5852f88f823f187c5afe03))
* **api:** OpenAPI spec update via Stainless API ([#164](https://github.com/cloudflare/cloudflare-python/issues/164)) ([5b83748](https://github.com/cloudflare/cloudflare-python/commit/5b837480481d86a1dfde84aa51fcbc4d94faf273))
* **api:** OpenAPI spec update via Stainless API ([#165](https://github.com/cloudflare/cloudflare-python/issues/165)) ([9872fdf](https://github.com/cloudflare/cloudflare-python/commit/9872fdfdedd7890d829755070a4b8617c275974a))
* **api:** OpenAPI spec update via Stainless API ([#166](https://github.com/cloudflare/cloudflare-python/issues/166)) ([fdc599e](https://github.com/cloudflare/cloudflare-python/commit/fdc599eb4803544505bd07f8359705373808efb2))
* **api:** OpenAPI spec update via Stainless API ([#167](https://github.com/cloudflare/cloudflare-python/issues/167)) ([0de118b](https://github.com/cloudflare/cloudflare-python/commit/0de118b0b3137fd3bbf41bd10fc9080f76c2632a))
* **api:** update via SDK Studio ([#156](https://github.com/cloudflare/cloudflare-python/issues/156)) ([3c1de95](https://github.com/cloudflare/cloudflare-python/commit/3c1de95c64fa9bf729385a73797286a9cece4aef))
* **api:** update via SDK Studio ([#158](https://github.com/cloudflare/cloudflare-python/issues/158)) ([15686e4](https://github.com/cloudflare/cloudflare-python/commit/15686e43fbade3aeeddde96b4bddca8c4c234afa))
* **api:** update via SDK Studio ([#159](https://github.com/cloudflare/cloudflare-python/issues/159)) ([abb60d4](https://github.com/cloudflare/cloudflare-python/commit/abb60d42cd24133dfc8e9e26bb42c8031333939c))
* **api:** update via SDK Studio ([#168](https://github.com/cloudflare/cloudflare-python/issues/168)) ([a0562cc](https://github.com/cloudflare/cloudflare-python/commit/a0562ccea6066c7408e3ba5068201f51f371ee06))

## 3.0.0-beta.4 (2024-03-20)

Full Changelog: [v3.0.0-beta.3...v3.0.0-beta.4](https://github.com/cloudflare/cloudflare-python/compare/v3.0.0-beta.3...v3.0.0-beta.4)
Expand Down
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ The Cloudflare Python library provides convenient access to the Cloudflare REST
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 developers.cloudflare.com](https://developers.cloudflare.com/api). The full API of this library can be found in [api.md](api.md).
Expand Down Expand Up @@ -306,6 +308,41 @@ with client.zones.with_streaming_response.create(

The context manager is required so that the response will reliably be closed.

### Making custom/undocumented requests

This library is typed for convenient access the documented API.

If you need to access undocumented endpoints, params, or response properties, the library can still be used.

#### Undocumented endpoints

To make requests to undocumented endpoints, you can make requests using `client.get`, `client.post`, and other
http verbs. Options on the client will be respected (such as retries) will be respected when making this
request.

```py
import httpx

response = client.post(
"/foo",
cast_to=httpx.Response,
body={"my_param": True},
)

print(response.headers.get("x-foo"))
```

#### Undocumented params

If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request
options.

#### Undocumented properties

To access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You
can also get all the extra fields on the Pydantic model as a dict with
[`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra).

### Configuring the HTTP client

You can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including:
Expand Down
Loading
Loading