origoid 0.1.0__tar.gz

origoid-0.1.0/PKG-INFO

@@ -0,0 +1,169 @@
+Metadata-Version: 2.1
+Name: origoid
+Version: 0.1.0
+Summary: 
+Requires-Python: >=3.8,<4.0
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Dist: httpx (>=0.21.2)
+Requires-Dist: pydantic (>=2.0.0)
+Requires-Dist: pydantic-core (>=2.18.2,<3.0.0)
+Requires-Dist: typing_extensions (>=4.0.0)
+Description-Content-Type: text/markdown
+
+# Origoid Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Forigoid%2Fsdk-python)
+[![pypi](https://img.shields.io/pypi/v/origoid)](https://pypi.python.org/pypi/origoid)
+
+The Origoid Python library provides convenient access to the Origoid APIs from Python.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Async Client](#async-client)
+- [Exception Handling](#exception-handling)
+- [Advanced](#advanced)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Custom Client](#custom-client)
+- [Contributing](#contributing)
+
+## Installation
+
+```sh
+pip install origoid
+```
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from origoid import OrigoID
+
+client = OrigoID(
+    api_key="YOUR_API_KEY",
+)
+client.authentication.issue_token()
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API.
+
+```python
+import asyncio
+
+from origoid import AsyncOrigoID
+
+client = AsyncOrigoID(
+    api_key="YOUR_API_KEY",
+)
+
+
+async def main() -> None:
+    await client.authentication.issue_token()
+
+
+asyncio.run(main())
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```python
+from origoid.core.api_error import ApiError
+
+try:
+    client.authentication.issue_token(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Advanced
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retriable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retriable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.authentication.issue_token(..., {
+    "max_retries": 1
+})
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
+
+```python
+
+from origoid import OrigoID
+
+client = OrigoID(
+    ...,
+    timeout=20.0,
+)
+
+
+# Override timeout for a specific method
+client.authentication.issue_token(..., {
+    "timeout_in_seconds": 1
+})
+```
+
+### Custom Client
+
+You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
+and transports.
+```python
+import httpx
+from origoid import OrigoID
+
+client = OrigoID(
+    ...,
+    httpx_client=httpx.Client(
+        proxies="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!
+

origoid-0.1.0/README.md

@@ -0,0 +1,142 @@
+# Origoid Python Library
+
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-Built%20with%20Fern-brightgreen)](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Forigoid%2Fsdk-python)
+[![pypi](https://img.shields.io/pypi/v/origoid)](https://pypi.python.org/pypi/origoid)
+
+The Origoid Python library provides convenient access to the Origoid APIs from Python.
+
+## Table of Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Async Client](#async-client)
+- [Exception Handling](#exception-handling)
+- [Advanced](#advanced)
+  - [Retries](#retries)
+  - [Timeouts](#timeouts)
+  - [Custom Client](#custom-client)
+- [Contributing](#contributing)
+
+## Installation
+
+```sh
+pip install origoid
+```
+
+## Usage
+
+Instantiate and use the client with the following:
+
+```python
+from origoid import OrigoID
+
+client = OrigoID(
+    api_key="YOUR_API_KEY",
+)
+client.authentication.issue_token()
+```
+
+## Async Client
+
+The SDK also exports an `async` client so that you can make non-blocking calls to our API.
+
+```python
+import asyncio
+
+from origoid import AsyncOrigoID
+
+client = AsyncOrigoID(
+    api_key="YOUR_API_KEY",
+)
+
+
+async def main() -> None:
+    await client.authentication.issue_token()
+
+
+asyncio.run(main())
+```
+
+## Exception Handling
+
+When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
+will be thrown.
+
+```python
+from origoid.core.api_error import ApiError
+
+try:
+    client.authentication.issue_token(...)
+except ApiError as e:
+    print(e.status_code)
+    print(e.body)
+```
+
+## Advanced
+
+### Retries
+
+The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
+as the request is deemed retriable and the number of retry attempts has not grown larger than the configured
+retry limit (default: 2).
+
+A request is deemed retriable when any of the following HTTP status codes is returned:
+
+- [408](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/408) (Timeout)
+- [429](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/429) (Too Many Requests)
+- [5XX](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/500) (Internal Server Errors)
+
+Use the `max_retries` request option to configure this behavior.
+
+```python
+client.authentication.issue_token(..., {
+    "max_retries": 1
+})
+```
+
+### Timeouts
+
+The SDK defaults to a 60 second timeout. You can configure this with a timeout option at the client or request level.
+
+```python
+
+from origoid import OrigoID
+
+client = OrigoID(
+    ...,
+    timeout=20.0,
+)
+
+
+# Override timeout for a specific method
+client.authentication.issue_token(..., {
+    "timeout_in_seconds": 1
+})
+```
+
+### Custom Client
+
+You can override the `httpx` client to customize it for your use-case. Some common use-cases include support for proxies
+and transports.
+```python
+import httpx
+from origoid import OrigoID
+
+client = OrigoID(
+    ...,
+    httpx_client=httpx.Client(
+        proxies="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+## Contributing
+
+While we value open-source contributions to this SDK, this library is generated programmatically.
+Additions made directly to this library would have to be moved over to our generation code,
+otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
+a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
+an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!

origoid-0.1.0/pyproject.toml

@@ -0,0 +1,61 @@
+[tool.poetry]
+name = "origoid"
+version = "0.1.0"
+description = ""
+readme = "README.md"
+authors = []
+keywords = []
+
+classifiers = [
+    "Intended Audience :: Developers",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Operating System :: OS Independent",
+    "Operating System :: POSIX",
+    "Operating System :: MacOS",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: Microsoft :: Windows",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed"
+]
+packages = [
+    { include = "origoid", from = "src"}
+]
+
+[project.urls]
+Repository = 'https://github.com/origoid/sdk-python'
+
+[tool.poetry.dependencies]
+python = "^3.8"
+httpx = ">=0.21.2"
+pydantic = ">= 2.0.0"
+pydantic-core = "^2.18.2"
+typing_extensions = ">= 4.0.0"
+
+[tool.poetry.dev-dependencies]
+mypy = "1.0.1"
+pytest = "^7.4.0"
+pytest-asyncio = "^0.23.5"
+python-dateutil = "^2.9.0"
+types-python-dateutil = "^2.9.0.20240316"
+ruff = "^0.5.6"
+
+[tool.pytest.ini_options]
+testpaths = [ "tests" ]
+asyncio_mode = "auto"
+
+[tool.mypy]
+plugins = ["pydantic.mypy"]
+
+[tool.ruff]
+line-length = 120
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

origoid-0.1.0/src/origoid/__init__.py

@@ -0,0 +1,42 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .types import Envelope, EnvelopeStatus, ErrorDetail
+from .errors import TooManyRequestsError, UnauthorizedError
+from . import authentication, biometrics, compliance, email, imss, ine, proof_of_address, renapo, sat
+from .biometrics import MatchFacesRequestDocumentType
+from .client import AsyncOrigoID, OrigoID
+from .compliance import SearchPepsRequest, SearchSat69BRequest, SearchSat69Request
+from .environment import OrigoIDEnvironment
+from .ine import ValidateVoterListRequest
+from .renapo import LookupCurpRequestGender
+from .sat import ExtractCsfRequest, ValidateCfdiRequest
+from .version import __version__
+
+__all__ = [
+    "AsyncOrigoID",
+    "Envelope",
+    "EnvelopeStatus",
+    "ErrorDetail",
+    "ExtractCsfRequest",
+    "LookupCurpRequestGender",
+    "MatchFacesRequestDocumentType",
+    "OrigoID",
+    "OrigoIDEnvironment",
+    "SearchPepsRequest",
+    "SearchSat69BRequest",
+    "SearchSat69Request",
+    "TooManyRequestsError",
+    "UnauthorizedError",
+    "ValidateCfdiRequest",
+    "ValidateVoterListRequest",
+    "__version__",
+    "authentication",
+    "biometrics",
+    "compliance",
+    "email",
+    "imss",
+    "ine",
+    "proof_of_address",
+    "renapo",
+    "sat",
+]

origoid-0.1.0/src/origoid/authentication/__init__.py

@@ -0,0 +1,2 @@
+# This file was auto-generated by Fern from our API Definition.
+

origoid-0.1.0/src/origoid/authentication/client.py

@@ -0,0 +1,162 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+from ..core.client_wrapper import SyncClientWrapper
+from ..core.request_options import RequestOptions
+from ..types.envelope import Envelope
+from ..core.pydantic_utilities import parse_obj_as
+from ..errors.unauthorized_error import UnauthorizedError
+from json.decoder import JSONDecodeError
+from ..core.api_error import ApiError
+from ..core.client_wrapper import AsyncClientWrapper
+
+# this is used as the default value for optional parameters
+OMIT = typing.cast(typing.Any, ...)
+
+
+class AuthenticationClient:
+    def __init__(self, *, client_wrapper: SyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    def issue_token(
+        self, *, expire_after: typing.Optional[int] = OMIT, request_options: typing.Optional[RequestOptions] = None
+    ) -> Envelope:
+        """
+        **Credits:** Free — authentication endpoint.
+
+        Issues a short-lived Bearer JWT token from valid API Key or Basic credentials. The token can then be used as `Authorization: Bearer <token>` on subsequent requests instead of resending your long-lived API Key. Useful when you need to delegate access to a downstream client without sharing your primary credentials.
+
+        The token's lifetime is returned in the `expires_in` field (seconds). Tokens are stateless — there is no revocation endpoint; if compromised, rotate the underlying API Key instead.
+
+        Parameters
+        ----------
+        expire_after : typing.Optional[int]
+            Seconds of validity (Default: 1800).
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Envelope
+            Token generated successfully.
+
+        Examples
+        --------
+        from origoid import OrigoID
+
+        client = OrigoID(
+            api_key="YOUR_API_KEY",
+        )
+        client.authentication.issue_token()
+        """
+        _response = self._client_wrapper.httpx_client.request(
+            "auth/token",
+            method="POST",
+            json={
+                "expireAfter": expire_after,
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    Envelope,
+                    parse_obj_as(
+                        type_=Envelope,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    typing.cast(
+                        Envelope,
+                        parse_obj_as(
+                            type_=Envelope,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)
+
+
+class AsyncAuthenticationClient:
+    def __init__(self, *, client_wrapper: AsyncClientWrapper):
+        self._client_wrapper = client_wrapper
+
+    async def issue_token(
+        self, *, expire_after: typing.Optional[int] = OMIT, request_options: typing.Optional[RequestOptions] = None
+    ) -> Envelope:
+        """
+        **Credits:** Free — authentication endpoint.
+
+        Issues a short-lived Bearer JWT token from valid API Key or Basic credentials. The token can then be used as `Authorization: Bearer <token>` on subsequent requests instead of resending your long-lived API Key. Useful when you need to delegate access to a downstream client without sharing your primary credentials.
+
+        The token's lifetime is returned in the `expires_in` field (seconds). Tokens are stateless — there is no revocation endpoint; if compromised, rotate the underlying API Key instead.
+
+        Parameters
+        ----------
+        expire_after : typing.Optional[int]
+            Seconds of validity (Default: 1800).
+
+        request_options : typing.Optional[RequestOptions]
+            Request-specific configuration.
+
+        Returns
+        -------
+        Envelope
+            Token generated successfully.
+
+        Examples
+        --------
+        import asyncio
+
+        from origoid import AsyncOrigoID
+
+        client = AsyncOrigoID(
+            api_key="YOUR_API_KEY",
+        )
+
+
+        async def main() -> None:
+            await client.authentication.issue_token()
+
+
+        asyncio.run(main())
+        """
+        _response = await self._client_wrapper.httpx_client.request(
+            "auth/token",
+            method="POST",
+            json={
+                "expireAfter": expire_after,
+            },
+            request_options=request_options,
+            omit=OMIT,
+        )
+        try:
+            if 200 <= _response.status_code < 300:
+                return typing.cast(
+                    Envelope,
+                    parse_obj_as(
+                        type_=Envelope,  # type: ignore
+                        object_=_response.json(),
+                    ),
+                )
+            if _response.status_code == 401:
+                raise UnauthorizedError(
+                    typing.cast(
+                        Envelope,
+                        parse_obj_as(
+                            type_=Envelope,  # type: ignore
+                            object_=_response.json(),
+                        ),
+                    )
+                )
+            _response_json = _response.json()
+        except JSONDecodeError:
+            raise ApiError(status_code=_response.status_code, body=_response.text)
+        raise ApiError(status_code=_response.status_code, body=_response_json)

origoid-0.1.0/src/origoid/biometrics/__init__.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+from .types import MatchFacesRequestDocumentType
+
+__all__ = ["MatchFacesRequestDocumentType"]