512 lines
19 KiB
Python
512 lines
19 KiB
Python
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
|
|
from __future__ import annotations
|
|
|
|
from typing import List
|
|
from typing_extensions import Literal
|
|
|
|
import httpx
|
|
|
|
from ... import _legacy_response
|
|
from ...types import container_list_params, container_create_params
|
|
from ..._types import NOT_GIVEN, Body, Query, Headers, NoneType, NotGiven
|
|
from ..._utils import maybe_transform, async_maybe_transform
|
|
from ..._compat import cached_property
|
|
from ..._resource import SyncAPIResource, AsyncAPIResource
|
|
from ..._response import to_streamed_response_wrapper, async_to_streamed_response_wrapper
|
|
from .files.files import (
|
|
Files,
|
|
AsyncFiles,
|
|
FilesWithRawResponse,
|
|
AsyncFilesWithRawResponse,
|
|
FilesWithStreamingResponse,
|
|
AsyncFilesWithStreamingResponse,
|
|
)
|
|
from ...pagination import SyncCursorPage, AsyncCursorPage
|
|
from ..._base_client import AsyncPaginator, make_request_options
|
|
from ...types.container_list_response import ContainerListResponse
|
|
from ...types.container_create_response import ContainerCreateResponse
|
|
from ...types.container_retrieve_response import ContainerRetrieveResponse
|
|
|
|
__all__ = ["Containers", "AsyncContainers"]
|
|
|
|
|
|
class Containers(SyncAPIResource):
|
|
@cached_property
|
|
def files(self) -> Files:
|
|
return Files(self._client)
|
|
|
|
@cached_property
|
|
def with_raw_response(self) -> ContainersWithRawResponse:
|
|
"""
|
|
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/openai/openai-python#accessing-raw-response-data-eg-headers
|
|
"""
|
|
return ContainersWithRawResponse(self)
|
|
|
|
@cached_property
|
|
def with_streaming_response(self) -> ContainersWithStreamingResponse:
|
|
"""
|
|
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
|
|
|
For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
|
"""
|
|
return ContainersWithStreamingResponse(self)
|
|
|
|
def create(
|
|
self,
|
|
*,
|
|
name: str,
|
|
expires_after: container_create_params.ExpiresAfter | NotGiven = NOT_GIVEN,
|
|
file_ids: List[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,
|
|
) -> ContainerCreateResponse:
|
|
"""
|
|
Create Container
|
|
|
|
Args:
|
|
name: Name of the container to create.
|
|
|
|
expires_after: Container expiration time in seconds relative to the 'anchor' time.
|
|
|
|
file_ids: IDs of files to copy to the container.
|
|
|
|
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
|
|
"""
|
|
return self._post(
|
|
"/containers",
|
|
body=maybe_transform(
|
|
{
|
|
"name": name,
|
|
"expires_after": expires_after,
|
|
"file_ids": file_ids,
|
|
},
|
|
container_create_params.ContainerCreateParams,
|
|
),
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=ContainerCreateResponse,
|
|
)
|
|
|
|
def retrieve(
|
|
self,
|
|
container_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,
|
|
) -> ContainerRetrieveResponse:
|
|
"""
|
|
Retrieve Container
|
|
|
|
Args:
|
|
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 container_id:
|
|
raise ValueError(f"Expected a non-empty value for `container_id` but received {container_id!r}")
|
|
return self._get(
|
|
f"/containers/{container_id}",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=ContainerRetrieveResponse,
|
|
)
|
|
|
|
def list(
|
|
self,
|
|
*,
|
|
after: str | NotGiven = NOT_GIVEN,
|
|
limit: int | NotGiven = NOT_GIVEN,
|
|
order: Literal["asc", "desc"] | 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,
|
|
) -> SyncCursorPage[ContainerListResponse]:
|
|
"""List Containers
|
|
|
|
Args:
|
|
after: A cursor for use in pagination.
|
|
|
|
`after` is an object ID that defines your place
|
|
in the list. For instance, if you make a list request and receive 100 objects,
|
|
ending with obj_foo, your subsequent call can include after=obj_foo in order to
|
|
fetch the next page of the list.
|
|
|
|
limit: A limit on the number of objects to be returned. Limit can range between 1 and
|
|
100, and the default is 20.
|
|
|
|
order: Sort order by the `created_at` timestamp of the objects. `asc` for ascending
|
|
order and `desc` for descending order.
|
|
|
|
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
|
|
"""
|
|
return self._get_api_list(
|
|
"/containers",
|
|
page=SyncCursorPage[ContainerListResponse],
|
|
options=make_request_options(
|
|
extra_headers=extra_headers,
|
|
extra_query=extra_query,
|
|
extra_body=extra_body,
|
|
timeout=timeout,
|
|
query=maybe_transform(
|
|
{
|
|
"after": after,
|
|
"limit": limit,
|
|
"order": order,
|
|
},
|
|
container_list_params.ContainerListParams,
|
|
),
|
|
),
|
|
model=ContainerListResponse,
|
|
)
|
|
|
|
def delete(
|
|
self,
|
|
container_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,
|
|
) -> None:
|
|
"""
|
|
Delete Container
|
|
|
|
Args:
|
|
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 container_id:
|
|
raise ValueError(f"Expected a non-empty value for `container_id` but received {container_id!r}")
|
|
extra_headers = {"Accept": "*/*", **(extra_headers or {})}
|
|
return self._delete(
|
|
f"/containers/{container_id}",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=NoneType,
|
|
)
|
|
|
|
|
|
class AsyncContainers(AsyncAPIResource):
|
|
@cached_property
|
|
def files(self) -> AsyncFiles:
|
|
return AsyncFiles(self._client)
|
|
|
|
@cached_property
|
|
def with_raw_response(self) -> AsyncContainersWithRawResponse:
|
|
"""
|
|
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/openai/openai-python#accessing-raw-response-data-eg-headers
|
|
"""
|
|
return AsyncContainersWithRawResponse(self)
|
|
|
|
@cached_property
|
|
def with_streaming_response(self) -> AsyncContainersWithStreamingResponse:
|
|
"""
|
|
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
|
|
|
|
For more information, see https://www.github.com/openai/openai-python#with_streaming_response
|
|
"""
|
|
return AsyncContainersWithStreamingResponse(self)
|
|
|
|
async def create(
|
|
self,
|
|
*,
|
|
name: str,
|
|
expires_after: container_create_params.ExpiresAfter | NotGiven = NOT_GIVEN,
|
|
file_ids: List[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,
|
|
) -> ContainerCreateResponse:
|
|
"""
|
|
Create Container
|
|
|
|
Args:
|
|
name: Name of the container to create.
|
|
|
|
expires_after: Container expiration time in seconds relative to the 'anchor' time.
|
|
|
|
file_ids: IDs of files to copy to the container.
|
|
|
|
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
|
|
"""
|
|
return await self._post(
|
|
"/containers",
|
|
body=await async_maybe_transform(
|
|
{
|
|
"name": name,
|
|
"expires_after": expires_after,
|
|
"file_ids": file_ids,
|
|
},
|
|
container_create_params.ContainerCreateParams,
|
|
),
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=ContainerCreateResponse,
|
|
)
|
|
|
|
async def retrieve(
|
|
self,
|
|
container_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,
|
|
) -> ContainerRetrieveResponse:
|
|
"""
|
|
Retrieve Container
|
|
|
|
Args:
|
|
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 container_id:
|
|
raise ValueError(f"Expected a non-empty value for `container_id` but received {container_id!r}")
|
|
return await self._get(
|
|
f"/containers/{container_id}",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=ContainerRetrieveResponse,
|
|
)
|
|
|
|
def list(
|
|
self,
|
|
*,
|
|
after: str | NotGiven = NOT_GIVEN,
|
|
limit: int | NotGiven = NOT_GIVEN,
|
|
order: Literal["asc", "desc"] | 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,
|
|
) -> AsyncPaginator[ContainerListResponse, AsyncCursorPage[ContainerListResponse]]:
|
|
"""List Containers
|
|
|
|
Args:
|
|
after: A cursor for use in pagination.
|
|
|
|
`after` is an object ID that defines your place
|
|
in the list. For instance, if you make a list request and receive 100 objects,
|
|
ending with obj_foo, your subsequent call can include after=obj_foo in order to
|
|
fetch the next page of the list.
|
|
|
|
limit: A limit on the number of objects to be returned. Limit can range between 1 and
|
|
100, and the default is 20.
|
|
|
|
order: Sort order by the `created_at` timestamp of the objects. `asc` for ascending
|
|
order and `desc` for descending order.
|
|
|
|
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
|
|
"""
|
|
return self._get_api_list(
|
|
"/containers",
|
|
page=AsyncCursorPage[ContainerListResponse],
|
|
options=make_request_options(
|
|
extra_headers=extra_headers,
|
|
extra_query=extra_query,
|
|
extra_body=extra_body,
|
|
timeout=timeout,
|
|
query=maybe_transform(
|
|
{
|
|
"after": after,
|
|
"limit": limit,
|
|
"order": order,
|
|
},
|
|
container_list_params.ContainerListParams,
|
|
),
|
|
),
|
|
model=ContainerListResponse,
|
|
)
|
|
|
|
async def delete(
|
|
self,
|
|
container_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,
|
|
) -> None:
|
|
"""
|
|
Delete Container
|
|
|
|
Args:
|
|
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 container_id:
|
|
raise ValueError(f"Expected a non-empty value for `container_id` but received {container_id!r}")
|
|
extra_headers = {"Accept": "*/*", **(extra_headers or {})}
|
|
return await self._delete(
|
|
f"/containers/{container_id}",
|
|
options=make_request_options(
|
|
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
|
|
),
|
|
cast_to=NoneType,
|
|
)
|
|
|
|
|
|
class ContainersWithRawResponse:
|
|
def __init__(self, containers: Containers) -> None:
|
|
self._containers = containers
|
|
|
|
self.create = _legacy_response.to_raw_response_wrapper(
|
|
containers.create,
|
|
)
|
|
self.retrieve = _legacy_response.to_raw_response_wrapper(
|
|
containers.retrieve,
|
|
)
|
|
self.list = _legacy_response.to_raw_response_wrapper(
|
|
containers.list,
|
|
)
|
|
self.delete = _legacy_response.to_raw_response_wrapper(
|
|
containers.delete,
|
|
)
|
|
|
|
@cached_property
|
|
def files(self) -> FilesWithRawResponse:
|
|
return FilesWithRawResponse(self._containers.files)
|
|
|
|
|
|
class AsyncContainersWithRawResponse:
|
|
def __init__(self, containers: AsyncContainers) -> None:
|
|
self._containers = containers
|
|
|
|
self.create = _legacy_response.async_to_raw_response_wrapper(
|
|
containers.create,
|
|
)
|
|
self.retrieve = _legacy_response.async_to_raw_response_wrapper(
|
|
containers.retrieve,
|
|
)
|
|
self.list = _legacy_response.async_to_raw_response_wrapper(
|
|
containers.list,
|
|
)
|
|
self.delete = _legacy_response.async_to_raw_response_wrapper(
|
|
containers.delete,
|
|
)
|
|
|
|
@cached_property
|
|
def files(self) -> AsyncFilesWithRawResponse:
|
|
return AsyncFilesWithRawResponse(self._containers.files)
|
|
|
|
|
|
class ContainersWithStreamingResponse:
|
|
def __init__(self, containers: Containers) -> None:
|
|
self._containers = containers
|
|
|
|
self.create = to_streamed_response_wrapper(
|
|
containers.create,
|
|
)
|
|
self.retrieve = to_streamed_response_wrapper(
|
|
containers.retrieve,
|
|
)
|
|
self.list = to_streamed_response_wrapper(
|
|
containers.list,
|
|
)
|
|
self.delete = to_streamed_response_wrapper(
|
|
containers.delete,
|
|
)
|
|
|
|
@cached_property
|
|
def files(self) -> FilesWithStreamingResponse:
|
|
return FilesWithStreamingResponse(self._containers.files)
|
|
|
|
|
|
class AsyncContainersWithStreamingResponse:
|
|
def __init__(self, containers: AsyncContainers) -> None:
|
|
self._containers = containers
|
|
|
|
self.create = async_to_streamed_response_wrapper(
|
|
containers.create,
|
|
)
|
|
self.retrieve = async_to_streamed_response_wrapper(
|
|
containers.retrieve,
|
|
)
|
|
self.list = async_to_streamed_response_wrapper(
|
|
containers.list,
|
|
)
|
|
self.delete = async_to_streamed_response_wrapper(
|
|
containers.delete,
|
|
)
|
|
|
|
@cached_property
|
|
def files(self) -> AsyncFilesWithStreamingResponse:
|
|
return AsyncFilesWithStreamingResponse(self._containers.files)
|