mirror of
https://github.com/cloudflare/cloudflare-python.git
synced 2026-01-12 06:53:21 +00:00
335 lines
13 KiB
Python
335 lines
13 KiB
Python
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
|
|
from __future__ import annotations
|
|
|
|
from typing import Type, cast
|
|
|
|
import httpx
|
|
|
|
from ...._types import NOT_GIVEN, Body, Query, Headers, NotGiven
|
|
from ...._utils import maybe_transform, strip_not_given, async_maybe_transform
|
|
from ...._compat import cached_property
|
|
from ...._resource import SyncAPIResource, AsyncAPIResource
|
|
from ...._response import (
|
|
BinaryAPIResponse,
|
|
AsyncBinaryAPIResponse,
|
|
StreamedBinaryAPIResponse,
|
|
AsyncStreamedBinaryAPIResponse,
|
|
to_raw_response_wrapper,
|
|
to_streamed_response_wrapper,
|
|
async_to_raw_response_wrapper,
|
|
to_custom_raw_response_wrapper,
|
|
async_to_streamed_response_wrapper,
|
|
to_custom_streamed_response_wrapper,
|
|
async_to_custom_raw_response_wrapper,
|
|
async_to_custom_streamed_response_wrapper,
|
|
)
|
|
from ...._wrappers import ResultWrapper
|
|
from ...._base_client import make_request_options
|
|
from ....types.workers.script import Script
|
|
from ....types.workers.scripts import content_update_params
|
|
from ....types.workers.worker_metadata_param import WorkerMetadataParam
|
|
|
|
__all__ = ["ContentResource", "AsyncContentResource"]
|
|
|
|
|
|
class ContentResource(SyncAPIResource):
|
|
@cached_property
|
|
def with_raw_response(self) -> ContentResourceWithRawResponse:
|
|
"""
|
|
This property can be used as a prefix for any HTTP method call to return
|
|
the raw response object instead of the parsed content.
|
|
|
|
For more information, see https://www.github.com/cloudflare/cloudflare-python#accessing-raw-response-data-eg-headers
|
|
"""
|
|
return ContentResourceWithRawResponse(self)
|
|
|
|
@cached_property
|
|
def with_streaming_response(self) -> ContentResourceWithStreamingResponse:
|
|
"""
|
|
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
|
|
|
For more information, see https://www.github.com/cloudflare/cloudflare-python#with_streaming_response
|
|
"""
|
|
return ContentResourceWithStreamingResponse(self)
|
|
|
|
def update(
|
|
self,
|
|
script_name: str,
|
|
*,
|
|
account_id: str,
|
|
metadata: WorkerMetadataParam,
|
|
cf_worker_body_part: str | NotGiven = NOT_GIVEN,
|
|
cf_worker_main_module_part: str | NotGiven = NOT_GIVEN,
|
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
extra_headers: Headers | None = None,
|
|
extra_query: Query | None = None,
|
|
extra_body: Body | None = None,
|
|
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
|
|
) -> Script:
|
|
"""
|
|
Put script content without touching config or metadata.
|
|
|
|
Args:
|
|
account_id: Identifier.
|
|
|
|
script_name: Name of the script, used in URLs and route configuration.
|
|
|
|
metadata: JSON encoded metadata about the uploaded parts and Worker configuration.
|
|
|
|
extra_headers: Send extra headers
|
|
|
|
extra_query: Add additional query parameters to the request
|
|
|
|
extra_body: Add additional JSON properties to the request
|
|
|
|
timeout: Override the client-level default timeout for this request, in seconds
|
|
"""
|
|
if not account_id:
|
|
raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
|
|
if not script_name:
|
|
raise ValueError(f"Expected a non-empty value for `script_name` but received {script_name!r}")
|
|
extra_headers = {
|
|
**strip_not_given(
|
|
{
|
|
"CF-WORKER-BODY-PART": cf_worker_body_part,
|
|
"CF-WORKER-MAIN-MODULE-PART": cf_worker_main_module_part,
|
|
}
|
|
),
|
|
**(extra_headers or {}),
|
|
}
|
|
# It should be noted that the actual Content-Type header that will be
|
|
# sent to the server will contain a `boundary` parameter, e.g.
|
|
# multipart/form-data; boundary=---abc--
|
|
extra_headers = {"Content-Type": "multipart/form-data", **(extra_headers or {})}
|
|
return self._put(
|
|
f"/accounts/{account_id}/workers/scripts/{script_name}/content",
|
|
body=maybe_transform({"metadata": metadata}, content_update_params.ContentUpdateParams),
|
|
options=make_request_options(
|
|
extra_headers=extra_headers,
|
|
extra_query=extra_query,
|
|
extra_body=extra_body,
|
|
timeout=timeout,
|
|
post_parser=ResultWrapper[Script]._unwrapper,
|
|
),
|
|
cast_to=cast(Type[Script], ResultWrapper[Script]),
|
|
)
|
|
|
|
def get(
|
|
self,
|
|
script_name: str,
|
|
*,
|
|
account_id: str,
|
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
extra_headers: Headers | None = None,
|
|
extra_query: Query | None = None,
|
|
extra_body: Body | None = None,
|
|
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
|
|
) -> BinaryAPIResponse:
|
|
"""
|
|
Fetch script content only.
|
|
|
|
Args:
|
|
account_id: Identifier.
|
|
|
|
script_name: Name of the script, used in URLs and route configuration.
|
|
|
|
extra_headers: Send extra headers
|
|
|
|
extra_query: Add additional query parameters to the request
|
|
|
|
extra_body: Add additional JSON properties to the request
|
|
|
|
timeout: Override the client-level default timeout for this request, in seconds
|
|
"""
|
|
if not account_id:
|
|
raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
|
|
if not script_name:
|
|
raise ValueError(f"Expected a non-empty value for `script_name` but received {script_name!r}")
|
|
extra_headers = {"Accept": "string", **(extra_headers or {})}
|
|
return self._get(
|
|
f"/accounts/{account_id}/workers/scripts/{script_name}/content/v2",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=BinaryAPIResponse,
|
|
)
|
|
|
|
|
|
class AsyncContentResource(AsyncAPIResource):
|
|
@cached_property
|
|
def with_raw_response(self) -> AsyncContentResourceWithRawResponse:
|
|
"""
|
|
This property can be used as a prefix for any HTTP method call to return
|
|
the raw response object instead of the parsed content.
|
|
|
|
For more information, see https://www.github.com/cloudflare/cloudflare-python#accessing-raw-response-data-eg-headers
|
|
"""
|
|
return AsyncContentResourceWithRawResponse(self)
|
|
|
|
@cached_property
|
|
def with_streaming_response(self) -> AsyncContentResourceWithStreamingResponse:
|
|
"""
|
|
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
|
|
|
For more information, see https://www.github.com/cloudflare/cloudflare-python#with_streaming_response
|
|
"""
|
|
return AsyncContentResourceWithStreamingResponse(self)
|
|
|
|
async def update(
|
|
self,
|
|
script_name: str,
|
|
*,
|
|
account_id: str,
|
|
metadata: WorkerMetadataParam,
|
|
cf_worker_body_part: str | NotGiven = NOT_GIVEN,
|
|
cf_worker_main_module_part: str | NotGiven = NOT_GIVEN,
|
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
extra_headers: Headers | None = None,
|
|
extra_query: Query | None = None,
|
|
extra_body: Body | None = None,
|
|
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
|
|
) -> Script:
|
|
"""
|
|
Put script content without touching config or metadata.
|
|
|
|
Args:
|
|
account_id: Identifier.
|
|
|
|
script_name: Name of the script, used in URLs and route configuration.
|
|
|
|
metadata: JSON encoded metadata about the uploaded parts and Worker configuration.
|
|
|
|
extra_headers: Send extra headers
|
|
|
|
extra_query: Add additional query parameters to the request
|
|
|
|
extra_body: Add additional JSON properties to the request
|
|
|
|
timeout: Override the client-level default timeout for this request, in seconds
|
|
"""
|
|
if not account_id:
|
|
raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
|
|
if not script_name:
|
|
raise ValueError(f"Expected a non-empty value for `script_name` but received {script_name!r}")
|
|
extra_headers = {
|
|
**strip_not_given(
|
|
{
|
|
"CF-WORKER-BODY-PART": cf_worker_body_part,
|
|
"CF-WORKER-MAIN-MODULE-PART": cf_worker_main_module_part,
|
|
}
|
|
),
|
|
**(extra_headers or {}),
|
|
}
|
|
# It should be noted that the actual Content-Type header that will be
|
|
# sent to the server will contain a `boundary` parameter, e.g.
|
|
# multipart/form-data; boundary=---abc--
|
|
extra_headers = {"Content-Type": "multipart/form-data", **(extra_headers or {})}
|
|
return await self._put(
|
|
f"/accounts/{account_id}/workers/scripts/{script_name}/content",
|
|
body=await async_maybe_transform({"metadata": metadata}, content_update_params.ContentUpdateParams),
|
|
options=make_request_options(
|
|
extra_headers=extra_headers,
|
|
extra_query=extra_query,
|
|
extra_body=extra_body,
|
|
timeout=timeout,
|
|
post_parser=ResultWrapper[Script]._unwrapper,
|
|
),
|
|
cast_to=cast(Type[Script], ResultWrapper[Script]),
|
|
)
|
|
|
|
async def get(
|
|
self,
|
|
script_name: str,
|
|
*,
|
|
account_id: str,
|
|
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
|
|
# The extra values given here take precedence over values defined on the client or passed to this method.
|
|
extra_headers: Headers | None = None,
|
|
extra_query: Query | None = None,
|
|
extra_body: Body | None = None,
|
|
timeout: float | httpx.Timeout | None | NotGiven = NOT_GIVEN,
|
|
) -> AsyncBinaryAPIResponse:
|
|
"""
|
|
Fetch script content only.
|
|
|
|
Args:
|
|
account_id: Identifier.
|
|
|
|
script_name: Name of the script, used in URLs and route configuration.
|
|
|
|
extra_headers: Send extra headers
|
|
|
|
extra_query: Add additional query parameters to the request
|
|
|
|
extra_body: Add additional JSON properties to the request
|
|
|
|
timeout: Override the client-level default timeout for this request, in seconds
|
|
"""
|
|
if not account_id:
|
|
raise ValueError(f"Expected a non-empty value for `account_id` but received {account_id!r}")
|
|
if not script_name:
|
|
raise ValueError(f"Expected a non-empty value for `script_name` but received {script_name!r}")
|
|
extra_headers = {"Accept": "string", **(extra_headers or {})}
|
|
return await self._get(
|
|
f"/accounts/{account_id}/workers/scripts/{script_name}/content/v2",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=AsyncBinaryAPIResponse,
|
|
)
|
|
|
|
|
|
class ContentResourceWithRawResponse:
|
|
def __init__(self, content: ContentResource) -> None:
|
|
self._content = content
|
|
|
|
self.update = to_raw_response_wrapper(
|
|
content.update,
|
|
)
|
|
self.get = to_custom_raw_response_wrapper(
|
|
content.get,
|
|
BinaryAPIResponse,
|
|
)
|
|
|
|
|
|
class AsyncContentResourceWithRawResponse:
|
|
def __init__(self, content: AsyncContentResource) -> None:
|
|
self._content = content
|
|
|
|
self.update = async_to_raw_response_wrapper(
|
|
content.update,
|
|
)
|
|
self.get = async_to_custom_raw_response_wrapper(
|
|
content.get,
|
|
AsyncBinaryAPIResponse,
|
|
)
|
|
|
|
|
|
class ContentResourceWithStreamingResponse:
|
|
def __init__(self, content: ContentResource) -> None:
|
|
self._content = content
|
|
|
|
self.update = to_streamed_response_wrapper(
|
|
content.update,
|
|
)
|
|
self.get = to_custom_streamed_response_wrapper(
|
|
content.get,
|
|
StreamedBinaryAPIResponse,
|
|
)
|
|
|
|
|
|
class AsyncContentResourceWithStreamingResponse:
|
|
def __init__(self, content: AsyncContentResource) -> None:
|
|
self._content = content
|
|
|
|
self.update = async_to_streamed_response_wrapper(
|
|
content.update,
|
|
)
|
|
self.get = async_to_custom_streamed_response_wrapper(
|
|
content.get,
|
|
AsyncStreamedBinaryAPIResponse,
|
|
)
|