# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

from __future__ import annotations

from typing_extensions import Literal

import httpx

from .limits import (

LimitsResource,

AsyncLimitsResource,

LimitsResourceWithRawResponse,

AsyncLimitsResourceWithRawResponse,

LimitsResourceWithStreamingResponse,

AsyncLimitsResourceWithStreamingResponse,

)

from ...types import project_list_params, project_create_params, project_update_params

from ..._types import Body, Omit, Query, Headers, NoneType, NotGiven, omit, not_given

from ..._utils import path_template, maybe_transform, async_maybe_transform

from ..._compat import cached_property

from ..._resource import SyncAPIResource, AsyncAPIResource

from ..._response import (

to_raw_response_wrapper,

to_streamed_response_wrapper,

async_to_raw_response_wrapper,

async_to_streamed_response_wrapper,

)

from ...pagination import SyncOffsetPagination, AsyncOffsetPagination

from ..._base_client import AsyncPaginator, make_request_options

from ...types.project import Project

__all__ = ["ProjectsResource", "AsyncProjectsResource"]

class ProjectsResource(SyncAPIResource):

"""

Create and manage projects for resource isolation within an organization.

When projects are disabled for the organization, project operations return

`404` with code `projects_disabled`.

"""

@cached_property

def limits(self) -> LimitsResource:

"""

Create and manage projects for resource isolation within an organization.

When projects are disabled for the organization, project operations return

`404` with code `projects_disabled`.

"""

return LimitsResource(self._client)

@cached_property

def with_raw_response(self) -> ProjectsResourceWithRawResponse:

"""

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/kernel/kernel-python-sdk#accessing-raw-response-data-eg-headers

"""

return ProjectsResourceWithRawResponse(self)

@cached_property

def with_streaming_response(self) -> ProjectsResourceWithStreamingResponse:

"""

An alternative to `.with_raw_response` that doesn't eagerly read the response body.

For more information, see https://www.github.com/kernel/kernel-python-sdk#with_streaming_response

"""

return ProjectsResourceWithStreamingResponse(self)

def create(

self,

*,

name: 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,

) -> Project:

"""

Create a new project within the authenticated organization.

Args:

name: Project name (1-255 Unicode code points; cannot contain `/` or `%`)

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(

"/org/projects",

body=maybe_transform({"name": name}, project_create_params.ProjectCreateParams),

options=make_request_options(

extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout

),

cast_to=Project,

)

def retrieve(

self,

id_or_name: 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,

) -> Project:

"""Get a project by its ID or by its name.

Names are unique within an organization.

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 id_or_name:

raise ValueError(f"Expected a non-empty value for `id_or_name` but received {id_or_name!r}")

return self._get(

path_template("/org/projects/{id_or_name}", id_or_name=id_or_name),

options=make_request_options(

extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout

),

cast_to=Project,

)

def update(

self,

id_or_name: str,

*,

name: str | Omit = omit,

status: Literal["active", "archived"] | Omit = omit,

# 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,

) -> Project:

"""

Update a project's name or status.

Args:

name: New project name (1-255 Unicode code points; cannot contain `/` or `%`)

status: New project status

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 id_or_name:

raise ValueError(f"Expected a non-empty value for `id_or_name` but received {id_or_name!r}")

return self._patch(

path_template("/org/projects/{id_or_name}", id_or_name=id_or_name),

body=maybe_transform(

{

"name": name,

"status": status,

},

project_update_params.ProjectUpdateParams,

),

options=make_request_options(

extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout

),

cast_to=Project,

)

def list(

self,

*,

limit: int | Omit = omit,

name: str | Omit = omit,

offset: int | Omit = omit,

query: str | Omit = omit,

# 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,

) -> SyncOffsetPagination[Project]:

"""

List projects for the authenticated organization.

Args:

limit: Maximum number of results to return

name: Exact-match filter on project name using the database collation. In production,

matching is case- and accent-insensitive.

offset: Number of results to skip

query: Case-insensitive substring match against project name

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(

"/org/projects",

page=SyncOffsetPagination[Project],

options=make_request_options(

extra_headers=extra_headers,

extra_query=extra_query,

extra_body=extra_body,

timeout=timeout,

query=maybe_transform(

{

"limit": limit,

"name": name,

"offset": offset,

"query": query,

},

project_list_params.ProjectListParams,

),

),

model=Project,

)

def delete(

self,

id_or_name: 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:

"""Soft-delete a project.

The project must be empty (no active resources).

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 id_or_name:

raise ValueError(f"Expected a non-empty value for `id_or_name` but received {id_or_name!r}")

extra_headers = {"Accept": "*/*", **(extra_headers or {})}

return self._delete(

path_template("/org/projects/{id_or_name}", id_or_name=id_or_name),

options=make_request_options(

extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout

),

cast_to=NoneType,

)

class AsyncProjectsResource(AsyncAPIResource):

"""

Create and manage projects for resource isolation within an organization.

When projects are disabled for the organization, project operations return

`404` with code `projects_disabled`.

"""

@cached_property

def limits(self) -> AsyncLimitsResource:

"""

Create and manage projects for resource isolation within an organization.

When projects are disabled for the organization, project operations return

`404` with code `projects_disabled`.

"""

return AsyncLimitsResource(self._client)

@cached_property

def with_raw_response(self) -> AsyncProjectsResourceWithRawResponse:

"""

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/kernel/kernel-python-sdk#accessing-raw-response-data-eg-headers

"""

return AsyncProjectsResourceWithRawResponse(self)

@cached_property

def with_streaming_response(self) -> AsyncProjectsResourceWithStreamingResponse:

"""

An alternative to `.with_raw_response` that doesn't eagerly read the response body.

For more information, see https://www.github.com/kernel/kernel-python-sdk#with_streaming_response

"""

return AsyncProjectsResourceWithStreamingResponse(self)

async def create(

self,

*,

name: 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,

) -> Project:

"""

Create a new project within the authenticated organization.

Args:

name: Project name (1-255 Unicode code points; cannot contain `/` or `%`)

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(

"/org/projects",

body=await async_maybe_transform({"name": name}, project_create_params.ProjectCreateParams),

options=make_request_options(

extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout

),

cast_to=Project,

)

async def retrieve(

self,

id_or_name: 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,

) -> Project:

"""Get a project by its ID or by its name.

Names are unique within an organization.

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 id_or_name:

raise ValueError(f"Expected a non-empty value for `id_or_name` but received {id_or_name!r}")

return await self._get(

path_template("/org/projects/{id_or_name}", id_or_name=id_or_name),

options=make_request_options(

extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout

),

cast_to=Project,

)

async def update(

self,

id_or_name: str,

*,

name: str | Omit = omit,

status: Literal["active", "archived"] | Omit = omit,

# 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,

) -> Project:

"""

Update a project's name or status.

Args:

name: New project name (1-255 Unicode code points; cannot contain `/` or `%`)

status: New project status

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 id_or_name:

raise ValueError(f"Expected a non-empty value for `id_or_name` but received {id_or_name!r}")

return await self._patch(

path_template("/org/projects/{id_or_name}", id_or_name=id_or_name),

body=await async_maybe_transform(

{

"name": name,

"status": status,

},

project_update_params.ProjectUpdateParams,

),

options=make_request_options(

extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout

),

cast_to=Project,

)

def list(

self,

*,

limit: int | Omit = omit,

name: str | Omit = omit,

offset: int | Omit = omit,

query: str | Omit = omit,

# 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[Project, AsyncOffsetPagination[Project]]:

"""

List projects for the authenticated organization.

Args:

limit: Maximum number of results to return

name: Exact-match filter on project name using the database collation. In production,

matching is case- and accent-insensitive.

offset: Number of results to skip

query: Case-insensitive substring match against project name

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(

"/org/projects",

page=AsyncOffsetPagination[Project],

options=make_request_options(

extra_headers=extra_headers,

extra_query=extra_query,

extra_body=extra_body,

timeout=timeout,

query=maybe_transform(

{

"limit": limit,

"name": name,

"offset": offset,

"query": query,

},

project_list_params.ProjectListParams,

),

),

model=Project,

)

async def delete(

self,

id_or_name: 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:

"""Soft-delete a project.

The project must be empty (no active resources).

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 id_or_name:

raise ValueError(f"Expected a non-empty value for `id_or_name` but received {id_or_name!r}")

extra_headers = {"Accept": "*/*", **(extra_headers or {})}

return await self._delete(

path_template("/org/projects/{id_or_name}", id_or_name=id_or_name),

options=make_request_options(

extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout

),

cast_to=NoneType,

)

class ProjectsResourceWithRawResponse:

def __init__(self, projects: ProjectsResource) -> None:

self._projects = projects

self.create = to_raw_response_wrapper(

projects.create,

)

self.retrieve = to_raw_response_wrapper(

projects.retrieve,

)

self.update = to_raw_response_wrapper(

projects.update,

)

self.list = to_raw_response_wrapper(

projects.list,

)

self.delete = to_raw_response_wrapper(

projects.delete,

)

@cached_property

def limits(self) -> LimitsResourceWithRawResponse:

"""

Create and manage projects for resource isolation within an organization.

When projects are disabled for the organization, project operations return

`404` with code `projects_disabled`.

"""

return LimitsResourceWithRawResponse(self._projects.limits)

class AsyncProjectsResourceWithRawResponse:

def __init__(self, projects: AsyncProjectsResource) -> None:

self._projects = projects

self.create = async_to_raw_response_wrapper(

projects.create,

)

self.retrieve = async_to_raw_response_wrapper(

projects.retrieve,

)

self.update = async_to_raw_response_wrapper(

projects.update,

)

self.list = async_to_raw_response_wrapper(

projects.list,

)

self.delete = async_to_raw_response_wrapper(

projects.delete,

)

@cached_property

def limits(self) -> AsyncLimitsResourceWithRawResponse:

"""

Create and manage projects for resource isolation within an organization.

When projects are disabled for the organization, project operations return

`404` with code `projects_disabled`.

"""

return AsyncLimitsResourceWithRawResponse(self._projects.limits)

class ProjectsResourceWithStreamingResponse:

def __init__(self, projects: ProjectsResource) -> None:

self._projects = projects

self.create = to_streamed_response_wrapper(

projects.create,

)

self.retrieve = to_streamed_response_wrapper(

projects.retrieve,

)

self.update = to_streamed_response_wrapper(

projects.update,

)

self.list = to_streamed_response_wrapper(

projects.list,

)

self.delete = to_streamed_response_wrapper(

projects.delete,

)

@cached_property

def limits(self) -> LimitsResourceWithStreamingResponse:

"""

Create and manage projects for resource isolation within an organization.

When projects are disabled for the organization, project operations return

`404` with code `projects_disabled`.

"""

return LimitsResourceWithStreamingResponse(self._projects.limits)

class AsyncProjectsResourceWithStreamingResponse:

def __init__(self, projects: AsyncProjectsResource) -> None:

self._projects = projects

self.create = async_to_streamed_response_wrapper(

projects.create,

)

self.retrieve = async_to_streamed_response_wrapper(

projects.retrieve,

)

self.update = async_to_streamed_response_wrapper(

projects.update,

)

self.list = async_to_streamed_response_wrapper(

projects.list,

)

self.delete = async_to_streamed_response_wrapper(

projects.delete,

)

@cached_property

def limits(self) -> AsyncLimitsResourceWithStreamingResponse:

"""

Create and manage projects for resource isolation within an organization.

When projects are disabled for the organization, project operations return

`404` with code `projects_disabled`.

"""

return AsyncLimitsResourceWithStreamingResponse(self._projects.limits)