arbi 0.18.0__py3-none-any.whl

arbi/resources/api/tag.py

@@ -0,0 +1,409 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import Optional
+
+import httpx
+
+from ..._types import Body, Omit, Query, Headers, NotGiven, omit, not_given
+from ..._utils import maybe_transform, strip_not_given, 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 ...types.api import tag_create_params, tag_update_params
+from ..._base_client import make_request_options
+from ...types.api.tag_create_response import TagCreateResponse
+from ...types.api.tag_delete_response import TagDeleteResponse
+from ...types.api.tag_update_response import TagUpdateResponse
+
+__all__ = ["TagResource", "AsyncTagResource"]
+
+
+class TagResource(SyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> TagResourceWithRawResponse:
+        """
+        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/arbitrationcity/arbi-python#accessing-raw-response-data-eg-headers
+        """
+        return TagResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> TagResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/arbitrationcity/arbi-python#with_streaming_response
+        """
+        return TagResourceWithStreamingResponse(self)
+
+    def create(
+        self,
+        *,
+        name: str,
+        workspace_ext_id: str,
+        instruction: Optional[str] | Omit = omit,
+        parent_ext_id: Optional[str] | Omit = omit,
+        shared: Optional[bool] | Omit = omit,
+        tag_type: tag_create_params.TagType | Omit = omit,
+        workspace_key: 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,
+    ) -> TagCreateResponse:
+        """
+        Create a new tag for a given workspace.
+
+        If 'shared' is provided, the tag will be set to shared or private accordingly.
+        If 'shared' is not provided, it defaults to True (shared).
+
+        Args:
+          tag_type: Tag format configuration stored as JSONB.
+
+              Type-specific fields:
+
+              - select: options (list of choices, can be single or multi-select)
+              - search: tag name is the query, chunks include relevance scores
+              - checkbox, text, number, folder: type only
+
+          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
+        """
+        extra_headers = {**strip_not_given({"workspace-key": workspace_key}), **(extra_headers or {})}
+        return self._post(
+            "/api/tag",
+            body=maybe_transform(
+                {
+                    "name": name,
+                    "workspace_ext_id": workspace_ext_id,
+                    "instruction": instruction,
+                    "parent_ext_id": parent_ext_id,
+                    "shared": shared,
+                    "tag_type": tag_type,
+                },
+                tag_create_params.TagCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=TagCreateResponse,
+        )
+
+    def update(
+        self,
+        tag_ext_id: str,
+        *,
+        instruction: Optional[str] | Omit = omit,
+        name: Optional[str] | Omit = omit,
+        parent_ext_id: Optional[str] | Omit = omit,
+        shared: Optional[bool] | Omit = omit,
+        workspace_key: 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,
+    ) -> TagUpdateResponse:
+        """
+        Update a tag by its external ID.
+
+        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 tag_ext_id:
+            raise ValueError(f"Expected a non-empty value for `tag_ext_id` but received {tag_ext_id!r}")
+        extra_headers = {**strip_not_given({"workspace-key": workspace_key}), **(extra_headers or {})}
+        return self._patch(
+            f"/api/tag/{tag_ext_id}",
+            body=maybe_transform(
+                {
+                    "instruction": instruction,
+                    "name": name,
+                    "parent_ext_id": parent_ext_id,
+                    "shared": shared,
+                },
+                tag_update_params.TagUpdateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=TagUpdateResponse,
+        )
+
+    def delete(
+        self,
+        tag_ext_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,
+    ) -> TagDeleteResponse:
+        """
+        Delete a tag by its external ID.
+
+        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 tag_ext_id:
+            raise ValueError(f"Expected a non-empty value for `tag_ext_id` but received {tag_ext_id!r}")
+        return self._delete(
+            f"/api/tag/{tag_ext_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=TagDeleteResponse,
+        )
+
+
+class AsyncTagResource(AsyncAPIResource):
+    @cached_property
+    def with_raw_response(self) -> AsyncTagResourceWithRawResponse:
+        """
+        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/arbitrationcity/arbi-python#accessing-raw-response-data-eg-headers
+        """
+        return AsyncTagResourceWithRawResponse(self)
+
+    @cached_property
+    def with_streaming_response(self) -> AsyncTagResourceWithStreamingResponse:
+        """
+        An alternative to `.with_raw_response` that doesn't eagerly read the response body.
+
+        For more information, see https://www.github.com/arbitrationcity/arbi-python#with_streaming_response
+        """
+        return AsyncTagResourceWithStreamingResponse(self)
+
+    async def create(
+        self,
+        *,
+        name: str,
+        workspace_ext_id: str,
+        instruction: Optional[str] | Omit = omit,
+        parent_ext_id: Optional[str] | Omit = omit,
+        shared: Optional[bool] | Omit = omit,
+        tag_type: tag_create_params.TagType | Omit = omit,
+        workspace_key: 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,
+    ) -> TagCreateResponse:
+        """
+        Create a new tag for a given workspace.
+
+        If 'shared' is provided, the tag will be set to shared or private accordingly.
+        If 'shared' is not provided, it defaults to True (shared).
+
+        Args:
+          tag_type: Tag format configuration stored as JSONB.
+
+              Type-specific fields:
+
+              - select: options (list of choices, can be single or multi-select)
+              - search: tag name is the query, chunks include relevance scores
+              - checkbox, text, number, folder: type only
+
+          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
+        """
+        extra_headers = {**strip_not_given({"workspace-key": workspace_key}), **(extra_headers or {})}
+        return await self._post(
+            "/api/tag",
+            body=await async_maybe_transform(
+                {
+                    "name": name,
+                    "workspace_ext_id": workspace_ext_id,
+                    "instruction": instruction,
+                    "parent_ext_id": parent_ext_id,
+                    "shared": shared,
+                    "tag_type": tag_type,
+                },
+                tag_create_params.TagCreateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=TagCreateResponse,
+        )
+
+    async def update(
+        self,
+        tag_ext_id: str,
+        *,
+        instruction: Optional[str] | Omit = omit,
+        name: Optional[str] | Omit = omit,
+        parent_ext_id: Optional[str] | Omit = omit,
+        shared: Optional[bool] | Omit = omit,
+        workspace_key: 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,
+    ) -> TagUpdateResponse:
+        """
+        Update a tag by its external ID.
+
+        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 tag_ext_id:
+            raise ValueError(f"Expected a non-empty value for `tag_ext_id` but received {tag_ext_id!r}")
+        extra_headers = {**strip_not_given({"workspace-key": workspace_key}), **(extra_headers or {})}
+        return await self._patch(
+            f"/api/tag/{tag_ext_id}",
+            body=await async_maybe_transform(
+                {
+                    "instruction": instruction,
+                    "name": name,
+                    "parent_ext_id": parent_ext_id,
+                    "shared": shared,
+                },
+                tag_update_params.TagUpdateParams,
+            ),
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=TagUpdateResponse,
+        )
+
+    async def delete(
+        self,
+        tag_ext_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,
+    ) -> TagDeleteResponse:
+        """
+        Delete a tag by its external ID.
+
+        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 tag_ext_id:
+            raise ValueError(f"Expected a non-empty value for `tag_ext_id` but received {tag_ext_id!r}")
+        return await self._delete(
+            f"/api/tag/{tag_ext_id}",
+            options=make_request_options(
+                extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
+            ),
+            cast_to=TagDeleteResponse,
+        )
+
+
+class TagResourceWithRawResponse:
+    def __init__(self, tag: TagResource) -> None:
+        self._tag = tag
+
+        self.create = to_raw_response_wrapper(
+            tag.create,
+        )
+        self.update = to_raw_response_wrapper(
+            tag.update,
+        )
+        self.delete = to_raw_response_wrapper(
+            tag.delete,
+        )
+
+
+class AsyncTagResourceWithRawResponse:
+    def __init__(self, tag: AsyncTagResource) -> None:
+        self._tag = tag
+
+        self.create = async_to_raw_response_wrapper(
+            tag.create,
+        )
+        self.update = async_to_raw_response_wrapper(
+            tag.update,
+        )
+        self.delete = async_to_raw_response_wrapper(
+            tag.delete,
+        )
+
+
+class TagResourceWithStreamingResponse:
+    def __init__(self, tag: TagResource) -> None:
+        self._tag = tag
+
+        self.create = to_streamed_response_wrapper(
+            tag.create,
+        )
+        self.update = to_streamed_response_wrapper(
+            tag.update,
+        )
+        self.delete = to_streamed_response_wrapper(
+            tag.delete,
+        )
+
+
+class AsyncTagResourceWithStreamingResponse:
+    def __init__(self, tag: AsyncTagResource) -> None:
+        self._tag = tag
+
+        self.create = async_to_streamed_response_wrapper(
+            tag.create,
+        )
+        self.update = async_to_streamed_response_wrapper(
+            tag.update,
+        )
+        self.delete = async_to_streamed_response_wrapper(
+            tag.delete,
+        )

arbi/resources/api/user/__init__.py

@@ -0,0 +1,61 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from .user import (
+    UserResource,
+    AsyncUserResource,
+    UserResourceWithRawResponse,
+    AsyncUserResourceWithRawResponse,
+    UserResourceWithStreamingResponse,
+    AsyncUserResourceWithStreamingResponse,
+)
+from .contacts import (
+    ContactsResource,
+    AsyncContactsResource,
+    ContactsResourceWithRawResponse,
+    AsyncContactsResourceWithRawResponse,
+    ContactsResourceWithStreamingResponse,
+    AsyncContactsResourceWithStreamingResponse,
+)
+from .settings import (
+    SettingsResource,
+    AsyncSettingsResource,
+    SettingsResourceWithRawResponse,
+    AsyncSettingsResourceWithRawResponse,
+    SettingsResourceWithStreamingResponse,
+    AsyncSettingsResourceWithStreamingResponse,
+)
+from .subscription import (
+    SubscriptionResource,
+    AsyncSubscriptionResource,
+    SubscriptionResourceWithRawResponse,
+    AsyncSubscriptionResourceWithRawResponse,
+    SubscriptionResourceWithStreamingResponse,
+    AsyncSubscriptionResourceWithStreamingResponse,
+)
+
+__all__ = [
+    "SettingsResource",
+    "AsyncSettingsResource",
+    "SettingsResourceWithRawResponse",
+    "AsyncSettingsResourceWithRawResponse",
+    "SettingsResourceWithStreamingResponse",
+    "AsyncSettingsResourceWithStreamingResponse",
+    "SubscriptionResource",
+    "AsyncSubscriptionResource",
+    "SubscriptionResourceWithRawResponse",
+    "AsyncSubscriptionResourceWithRawResponse",
+    "SubscriptionResourceWithStreamingResponse",
+    "AsyncSubscriptionResourceWithStreamingResponse",
+    "ContactsResource",
+    "AsyncContactsResource",
+    "ContactsResourceWithRawResponse",
+    "AsyncContactsResourceWithRawResponse",
+    "ContactsResourceWithStreamingResponse",
+    "AsyncContactsResourceWithStreamingResponse",
+    "UserResource",
+    "AsyncUserResource",
+    "UserResourceWithRawResponse",
+    "AsyncUserResourceWithRawResponse",
+    "UserResourceWithStreamingResponse",
+    "AsyncUserResourceWithStreamingResponse",
+]