together 2.0.0a17__py3-none-any.whl → 2.0.0a18__py3-none-any.whl

together/resources/beta/jig/secrets.py

@@ -0,0 +1,548 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+import httpx
+
+from ...._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
+from ...._utils import 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 ...._base_client import make_request_options
+from ....types.beta.jig import secret_create_params, secret_update_params
+from ....types.beta.jig.secret import Secret
+from ....types.beta.jig.secret_list_response import SecretListResponse
+
+__all__ = ["SecretsResource", "AsyncSecretsResource"]
+
+
+class SecretsResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> SecretsResourceWithRawResponse:
+        """
+        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/togethercomputer/together-py#accessing-raw-response-data-eg-headers
+        """
+        return SecretsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> SecretsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/togethercomputer/together-py#with_streaming_response
+        """
+        return SecretsResourceWithStreamingResponse(self)
+
+    def create(
+        self,
+        *,
+        name: str,
+        value: str,
+        description: str | Omit = omit,
+        project_id: 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,
+    ) -> Secret:
+        """
+        Create a new secret to store sensitive configuration values
+
+        Args:
+          name: Name is the unique identifier for the secret. Can contain alphanumeric
+              characters, underscores, hyphens, forward slashes, and periods (1-100
+              characters)
+
+          value: Value is the sensitive data to store securely (e.g., API keys, passwords,
+              tokens). This value will be encrypted at rest
+
+          description: Description is an optional human-readable description of the secret's purpose
+              (max 500 characters)
+
+          project_id: ProjectID is ignored - the project is automatically determined from your
+              authentication
+
+          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(
+            "/deployments/secrets",
+            body=maybe_transform(
+                {
+                    "name": name,
+                    "value": value,
+                    "description": description,
+                    "project_id": project_id,
+                },
+                secret_create_params.SecretCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Secret,
+        )
+
+    def retrieve(
+        self,
+        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,
+    ) -> Secret:
+        """
+        Retrieve details of a specific secret by its ID or name
+
+        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:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return self._get(
+            f"/deployments/secrets/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Secret,
+        )
+
+    def update(
+        self,
+        id: str,
+        *,
+        description: str | Omit = omit,
+        name: str | Omit = omit,
+        project_id: str | Omit = omit,
+        value: 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,
+    ) -> Secret:
+        """
+        Update an existing secret's value or metadata
+
+        Args:
+          description: Description is an optional human-readable description of the secret's purpose
+              (max 500 characters)
+
+          name: Name is the new unique identifier for the secret. Can contain alphanumeric
+              characters, underscores, hyphens, forward slashes, and periods (1-100
+              characters)
+
+          project_id: ProjectID is ignored - the project is automatically determined from your
+              authentication
+
+          value: Value is the new sensitive data to store securely. Updating this will replace
+              the existing secret value
+
+          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:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return self._patch(
+            f"/deployments/secrets/{id}",
+            body=maybe_transform(
+                {
+                    "description": description,
+                    "name": name,
+                    "project_id": project_id,
+                    "value": value,
+                },
+                secret_update_params.SecretUpdateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Secret,
+        )
+
+    def list(
+        self,
+        *,
+        # 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,
+    ) -> SecretListResponse:
+        """Retrieve all secrets in your project"""
+        return self._get(
+            "/deployments/secrets",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=SecretListResponse,
+        )
+
+    def delete(
+        self,
+        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,
+    ) -> object:
+        """
+        Delete an existing secret
+
+        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:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return self._delete(
+            f"/deployments/secrets/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=object,
+        )
+
+
+class AsyncSecretsResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncSecretsResourceWithRawResponse:
+        """
+        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/togethercomputer/together-py#accessing-raw-response-data-eg-headers
+        """
+        return AsyncSecretsResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncSecretsResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/togethercomputer/together-py#with_streaming_response
+        """
+        return AsyncSecretsResourceWithStreamingResponse(self)
+
+    async def create(
+        self,
+        *,
+        name: str,
+        value: str,
+        description: str | Omit = omit,
+        project_id: 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,
+    ) -> Secret:
+        """
+        Create a new secret to store sensitive configuration values
+
+        Args:
+          name: Name is the unique identifier for the secret. Can contain alphanumeric
+              characters, underscores, hyphens, forward slashes, and periods (1-100
+              characters)
+
+          value: Value is the sensitive data to store securely (e.g., API keys, passwords,
+              tokens). This value will be encrypted at rest
+
+          description: Description is an optional human-readable description of the secret's purpose
+              (max 500 characters)
+
+          project_id: ProjectID is ignored - the project is automatically determined from your
+              authentication
+
+          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(
+            "/deployments/secrets",
+            body=await async_maybe_transform(
+                {
+                    "name": name,
+                    "value": value,
+                    "description": description,
+                    "project_id": project_id,
+                },
+                secret_create_params.SecretCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Secret,
+        )
+
+    async def retrieve(
+        self,
+        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,
+    ) -> Secret:
+        """
+        Retrieve details of a specific secret by its ID or name
+
+        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:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return await self._get(
+            f"/deployments/secrets/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Secret,
+        )
+
+    async def update(
+        self,
+        id: str,
+        *,
+        description: str | Omit = omit,
+        name: str | Omit = omit,
+        project_id: str | Omit = omit,
+        value: 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,
+    ) -> Secret:
+        """
+        Update an existing secret's value or metadata
+
+        Args:
+          description: Description is an optional human-readable description of the secret's purpose
+              (max 500 characters)
+
+          name: Name is the new unique identifier for the secret. Can contain alphanumeric
+              characters, underscores, hyphens, forward slashes, and periods (1-100
+              characters)
+
+          project_id: ProjectID is ignored - the project is automatically determined from your
+              authentication
+
+          value: Value is the new sensitive data to store securely. Updating this will replace
+              the existing secret value
+
+          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:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return await self._patch(
+            f"/deployments/secrets/{id}",
+            body=await async_maybe_transform(
+                {
+                    "description": description,
+                    "name": name,
+                    "project_id": project_id,
+                    "value": value,
+                },
+                secret_update_params.SecretUpdateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=Secret,
+        )
+
+    async def list(
+        self,
+        *,
+        # 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,
+    ) -> SecretListResponse:
+        """Retrieve all secrets in your project"""
+        return await self._get(
+            "/deployments/secrets",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=SecretListResponse,
+        )
+
+    async def delete(
+        self,
+        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,
+    ) -> object:
+        """
+        Delete an existing secret
+
+        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:
+            raise ValueError(f"Expected a non-empty value for `id` but received {id!r}")
+        return await self._delete(
+            f"/deployments/secrets/{id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=object,
+        )
+
+
+class SecretsResourceWithRawResponse:
+    def __init__(self, secrets: SecretsResource) -> None:
+        self._secrets = secrets
+
+        self.create = to_raw_response_wrapper(
+            secrets.create,
+        )
+        self.retrieve = to_raw_response_wrapper(
+            secrets.retrieve,
+        )
+        self.update = to_raw_response_wrapper(
+            secrets.update,
+        )
+        self.list = to_raw_response_wrapper(
+            secrets.list,
+        )
+        self.delete = to_raw_response_wrapper(
+            secrets.delete,
+        )
+
+
+class AsyncSecretsResourceWithRawResponse:
+    def __init__(self, secrets: AsyncSecretsResource) -> None:
+        self._secrets = secrets
+
+        self.create = async_to_raw_response_wrapper(
+            secrets.create,
+        )
+        self.retrieve = async_to_raw_response_wrapper(
+            secrets.retrieve,
+        )
+        self.update = async_to_raw_response_wrapper(
+            secrets.update,
+        )
+        self.list = async_to_raw_response_wrapper(
+            secrets.list,
+        )
+        self.delete = async_to_raw_response_wrapper(
+            secrets.delete,
+        )
+
+
+class SecretsResourceWithStreamingResponse:
+    def __init__(self, secrets: SecretsResource) -> None:
+        self._secrets = secrets
+
+        self.create = to_streamed_response_wrapper(
+            secrets.create,
+        )
+        self.retrieve = to_streamed_response_wrapper(
+            secrets.retrieve,
+        )
+        self.update = to_streamed_response_wrapper(
+            secrets.update,
+        )
+        self.list = to_streamed_response_wrapper(
+            secrets.list,
+        )
+        self.delete = to_streamed_response_wrapper(
+            secrets.delete,
+        )
+
+
+class AsyncSecretsResourceWithStreamingResponse:
+    def __init__(self, secrets: AsyncSecretsResource) -> None:
+        self._secrets = secrets
+
+        self.create = async_to_streamed_response_wrapper(
+            secrets.create,
+        )
+        self.retrieve = async_to_streamed_response_wrapper(
+            secrets.retrieve,
+        )
+        self.update = async_to_streamed_response_wrapper(
+            secrets.update,
+        )
+        self.list = async_to_streamed_response_wrapper(
+            secrets.list,
+        )
+        self.delete = async_to_streamed_response_wrapper(
+            secrets.delete,
+        )