pulse-python-sdk 0.0.52__py3-none-any.whl

pulse/types/extract_response.py

@@ -0,0 +1,47 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class ExtractResponse(UncheckedBaseModel):
+    """
+    High-level structure returned by the synchronous extract API.
+    """
+
+    content: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Primary markdown content extracted from the document.
+    """
+
+    html: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Optional HTML representation when returnHtml is true.
+    """
+
+    job_id: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Identifier assigned to the extraction job.
+    """
+
+    warnings: typing.Optional[typing.List[str]] = pydantic.Field(default=None)
+    """
+    Non-fatal warnings generated during extraction.
+    """
+
+    metadata: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None)
+    """
+    Additional metadata supplied by the backend.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pulse/types/extract_source_multipart_one.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.serialization import FieldMetadata
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class ExtractSourceMultipartOne(UncheckedBaseModel):
+    file_url: typing_extensions.Annotated[str, FieldMetadata(alias="fileUrl")] = pydantic.Field()
+    """
+    Public or pre-signed URL that Pulse will download and extract.
+    """
+
+    file: typing.Optional[typing.Any] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pulse/types/extract_source_multipart_zero.py

@@ -0,0 +1,27 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.serialization import FieldMetadata
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class ExtractSourceMultipartZero(UncheckedBaseModel):
+    file: str = pydantic.Field()
+    """
+    Document to upload directly.
+    """
+
+    file_url: typing_extensions.Annotated[typing.Optional[typing.Any], FieldMetadata(alias="fileUrl")] = None
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pulse/types/job_cancellation_response.py

@@ -0,0 +1,32 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class JobCancellationResponse(UncheckedBaseModel):
+    """
+    Confirmation payload returned after successfully canceling a job.
+    """
+
+    job_id: str = pydantic.Field()
+    """
+    Identifier of the job that was cancelled.
+    """
+
+    message: str = pydantic.Field()
+    """
+    Human-readable confirmation message.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pulse/types/job_status.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+JobStatus = typing.Union[typing.Literal["pending", "processing", "completed", "failed", "canceled"], typing.Any]

pulse/types/job_status_response.py

@@ -0,0 +1,50 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import datetime as dt
+import typing
+
+import pydantic
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.unchecked_base_model import UncheckedBaseModel
+from .job_status import JobStatus
+
+
+class JobStatusResponse(UncheckedBaseModel):
+    """
+    Current status and metadata for an asynchronous extraction job.
+    """
+
+    job_id: str = pydantic.Field()
+    """
+    Identifier assigned to the asynchronous extraction job.
+    """
+
+    status: JobStatus
+    created_at: dt.datetime = pydantic.Field()
+    """
+    Timestamp when the job was accepted.
+    """
+
+    updated_at: typing.Optional[dt.datetime] = pydantic.Field(default=None)
+    """
+    Timestamp of the last status update, if available.
+    """
+
+    result: typing.Optional[typing.Dict[str, typing.Any]] = pydantic.Field(default=None)
+    """
+    Structured payload that contains extraction output when the job is completed.
+    """
+
+    error: typing.Optional[str] = pydantic.Field(default=None)
+    """
+    Error message describing why the job failed, if applicable.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pulse/types/json_source.py

@@ -0,0 +1,29 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+import typing_extensions
+from ..core.pydantic_utilities import IS_PYDANTIC_V2
+from ..core.serialization import FieldMetadata
+from ..core.unchecked_base_model import UncheckedBaseModel
+
+
+class JsonSource(UncheckedBaseModel):
+    """
+    Document source definition for JSON requests.
+    """
+
+    file_url: typing_extensions.Annotated[str, FieldMetadata(alias="fileUrl")] = pydantic.Field()
+    """
+    Public or pre-signed URL that Pulse will download and extract.
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow

pulse/types/multipart_source.py

@@ -0,0 +1,8 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .extract_source_multipart_one import ExtractSourceMultipartOne
+from .extract_source_multipart_zero import ExtractSourceMultipartZero
+
+MultipartSource = typing.Union[ExtractSourceMultipartZero, ExtractSourceMultipartOne]

pulse/version.py

@@ -0,0 +1,3 @@
+from importlib import metadata
+
+__version__ = metadata.version("pulse-python-sdk")

pulse/webhooks/__init__.py

@@ -0,0 +1,4 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+

pulse/webhooks/client.py

@@ -0,0 +1,104 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.request_options import RequestOptions
+from .raw_client import AsyncRawWebhooksClient, RawWebhooksClient
+from .types.create_webhook_link_response import CreateWebhookLinkResponse
+
+
+class WebhooksClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._raw_client = RawWebhooksClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> RawWebhooksClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        RawWebhooksClient
+        """
+        return self._raw_client
+
+    def create_webhook_link(
+        self, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> CreateWebhookLinkResponse:
+        """
+        Generates a temporary link to the Svix webhook portal where users can manage their webhook endpoints and view message logs.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateWebhookLinkResponse
+            Webhook portal link created
+
+        Examples
+        --------
+        from pulse import Pulse
+
+        client = Pulse(
+            api_key="YOUR_API_KEY",
+        )
+        client.webhooks.create_webhook_link()
+        """
+        _response = self._raw_client.create_webhook_link(request_options=request_options)
+        return _response.data
+
+
+class AsyncWebhooksClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._raw_client = AsyncRawWebhooksClient(client_wrapper=client_wrapper)
+
+    @property
+    def with_raw_response(self) -> AsyncRawWebhooksClient:
+        """
+        Retrieves a raw implementation of this client that returns raw responses.
+
+        Returns
+        -------
+        AsyncRawWebhooksClient
+        """
+        return self._raw_client
+
+    async def create_webhook_link(
+        self, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> CreateWebhookLinkResponse:
+        """
+        Generates a temporary link to the Svix webhook portal where users can manage their webhook endpoints and view message logs.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        CreateWebhookLinkResponse
+            Webhook portal link created
+
+        Examples
+        --------
+        import asyncio
+
+        from pulse import AsyncPulse
+
+        client = AsyncPulse(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.webhooks.create_webhook_link()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._raw_client.create_webhook_link(request_options=request_options)
+        return _response.data

pulse/webhooks/raw_client.py

@@ -0,0 +1,139 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from json.decoder import JSONDecodeError
+
+from ..core.api_error import ApiError
+from ..core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from ..core.http_response import AsyncHttpResponse, HttpResponse
+from ..core.request_options import RequestOptions
+from ..core.unchecked_base_model import construct_type
+from ..errors.internal_server_error import InternalServerError
+from ..errors.unauthorized_error import UnauthorizedError
+from .types.create_webhook_link_response import CreateWebhookLinkResponse
+
+
+class RawWebhooksClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def create_webhook_link(
+        self, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> HttpResponse[CreateWebhookLinkResponse]:
+        """
+        Generates a temporary link to the Svix webhook portal where users can manage their webhook endpoints and view message logs.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        HttpResponse[CreateWebhookLinkResponse]
+            Webhook portal link created
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "webhook",
+            method="POST",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    CreateWebhookLinkResponse,
+                    construct_type(
+                        type_=CreateWebhookLinkResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return HttpResponse(response=_response, data=_data)
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        construct_type(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        construct_type(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)
+
+
+class AsyncRawWebhooksClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def create_webhook_link(
+        self, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> AsyncHttpResponse[CreateWebhookLinkResponse]:
+        """
+        Generates a temporary link to the Svix webhook portal where users can manage their webhook endpoints and view message logs.
+
+        Parameters
+        ----------
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        AsyncHttpResponse[CreateWebhookLinkResponse]
+            Webhook portal link created
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "webhook",
+            method="POST",
+            request_options=request_options,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                _data = typing.cast(
+                    CreateWebhookLinkResponse,
+                    construct_type(
+                        type_=CreateWebhookLinkResponse,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+                return AsyncHttpResponse(response=_response, data=_data)
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        construct_type(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            if _response.status_code == 500:
+                raise InternalServerError(
+                    headers=dict(_response.headers),
+                    body=typing.cast(
+                        typing.Any,
+                        construct_type(
+                            type_=typing.Any,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    ),
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response.text)
+        raise ApiError(status_code=_response.status_code, headers=dict(_response.headers), body=_response_json)

pulse/webhooks/types/__init__.py

@@ -0,0 +1,4 @@
+# This file was auto-generated by Fern from our API Definition.
+
+# isort: skip_file
+

pulse/webhooks/types/create_webhook_link_response.py

@@ -0,0 +1,23 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+import pydantic
+from ...core.pydantic_utilities import IS_PYDANTIC_V2
+from ...core.unchecked_base_model import UncheckedBaseModel
+
+
+class CreateWebhookLinkResponse(UncheckedBaseModel):
+    link: str = pydantic.Field()
+    """
+    URL to the Svix webhook portal
+    """
+
+    if IS_PYDANTIC_V2:
+        model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2
+    else:
+
+        class Config:
+            frozen = True
+            smart_union = True
+            extra = pydantic.Extra.allow