onfido-python 2.10.0__py3-none-any.whl → 3.1.0__py3-none-any.whl

onfido/aio_resource.py

@@ -1,132 +0,0 @@
-from aiohttp import AsyncIterablePayload, ClientSession, MultipartWriter, StringPayload
-from .exceptions import OnfidoRequestError
-from aiohttp.client_reqrep import ClientResponse
-from .onfido_download import OnfidoAioDownload
-from .exceptions import async_error_decorator, OnfidoUnknownError
-from .mimetype import mimetype_from_name
-from .utils import form_data_converter
-from typing import BinaryIO
-
-try:
-    import importlib.metadata as importlib_metadata
-except ImportError:
-    import importlib_metadata
-
-CURRENT_VERSION = importlib_metadata.version("onfido-python")
-
-
-class Resource:
-    def __init__(self, api_token, region, aio_session: ClientSession, timeout):
-        self._api_token = api_token
-        self._region = region
-        self._timeout = timeout
-        self._aio_session = aio_session
-
-    @property
-    def _url(self):
-        return getattr(self._region, "region_url", self._region)
-
-    def _build_url(self, path):
-        return self._url + path
-
-    @property
-    def _headers(self):
-        return {
-            "User-Agent": f"onfido-python/{CURRENT_VERSION}",
-            "Authorization": f"Token token={self._api_token}",
-        }
-
-    async def _handle_response(self, response: ClientResponse):
-        if response.status == 422:
-            error = None
-            if response.code == 422:
-                content_type = response.headers.get("Content-Type", "")
-                if "application/json" in content_type:
-                    resp_json = await response.json()
-                    error = resp_json.get("error")
-            raise OnfidoRequestError(error)
-
-        response.raise_for_status()
-        if response.status == 204:
-            return None
-
-        try:
-            return await response.json()
-        except ValueError as e:
-            raise OnfidoUnknownError("Onfido returned invalid JSON") from e
-
-    @async_error_decorator
-    async def _upload_request(self, path, file: BinaryIO, **request_body):
-        import uuid
-
-        boundary = uuid.uuid4().hex
-        with MultipartWriter("form-data", boundary=boundary) as mpwriter:
-            for k, v in form_data_converter(request_body).items():
-                part = mpwriter.append(
-                    StringPayload(
-                        v, headers={"Content-Disposition": f'form-data; name="{k}"'}
-                    )
-                )
-
-            file_part = mpwriter.append_payload(
-                AsyncIterablePayload(
-                    file,
-                    content_type=mimetype_from_name(file.name),
-                    headers={
-                        "Content-Disposition": f'form-data; name="file"; filename="{file.name}"'
-                    },
-                )
-            )
-            additional_headers = {
-                "Content-Type": f"multipart/form-data;boundary={boundary}"
-            }
-            async with self._aio_session.post(
-                self._build_url(path),
-                data=mpwriter,
-                headers=dict(self._headers, **additional_headers),
-                timeout=self._timeout,
-            ) as response:
-                return await self._handle_response(response)
-
-    @async_error_decorator
-    async def _post(self, path, **request_body):
-        async with self._aio_session.post(
-            self._build_url(path),
-            json=request_body,
-            headers=self._headers,
-            timeout=self._timeout,
-        ) as response:
-            return await self._handle_response(response)
-
-    @async_error_decorator
-    async def _put(self, path, data=None):
-        async with self._aio_session.put(
-            self._build_url(path),
-            json=data,
-            headers=self._headers,
-            timeout=self._timeout,
-        ) as response:
-            return await self._handle_response(response)
-
-    @async_error_decorator
-    async def _get(self, path, payload=None):
-        async with self._aio_session.get(
-            self._build_url(path), headers=self._headers, timeout=self._timeout
-        ) as response:
-            return await self._handle_response(response)
-
-    @async_error_decorator
-    async def _download_request(self, path):
-        async with self._aio_session.get(
-            self._build_url(path), headers=self._headers, timeout=self._timeout
-        ) as response:
-            response.raise_for_status()
-
-            return OnfidoAioDownload(response)
-
-    @async_error_decorator
-    async def _delete_request(self, path):
-        async with self._aio_session.delete(
-            self._build_url(path), headers=self._headers, timeout=self._timeout
-        ) as response:
-            return await self._handle_response(response)

onfido/mimetype.py

@@ -1,5 +0,0 @@
-import mimetypes
-
-def mimetype_from_name(filename):
-    mimetype, _ = mimetypes.guess_type(filename)
-    return mimetype

onfido/onfido.py

@@ -1,71 +0,0 @@
-from .resources.applicants import Applicants
-from .resources.documents import Documents
-from .resources.address_picker import Addresses
-from .resources.checks import Checks
-from .resources.workflow_runs import WorkflowRuns
-from .resources.reports import Reports
-from .resources.live_photos import LivePhotos
-from .resources.live_videos import LiveVideos
-from .resources.motion_captures import MotionCaptures
-from .resources.webhooks import Webhooks
-from .resources.sdk_tokens import SdkToken
-from .resources.extraction import Extraction
-from .resources.watchlist_monitors import WatchlistMonitors
-from .regions import Region
-from .exceptions import OnfidoRegionError
-
-from .resources_aio.applicants import Applicants as AsyncApplicants
-from .resources_aio.documents import Documents as AsyncDocuments
-from .resources_aio.address_picker import Addresses as AsyncAddresses
-from .resources_aio.checks import Checks as AsyncChecks
-from .resources_aio.workflow_runs import WorkflowRuns as AsyncWorkflowRuns
-from .resources_aio.reports import Reports as AsyncReports
-from .resources_aio.live_photos import LivePhotos as AsyncLivePhotos
-from .resources_aio.live_videos import LiveVideos as AsyncLiveVideos
-from .resources_aio.motion_captures import MotionCaptures as AsyncMotionCaptures
-from .resources_aio.webhooks import Webhooks as AsyncWebhooks
-from .resources_aio.sdk_tokens import SdkToken as AsyncSdkToken
-from .resources_aio.extraction import Extraction as AsyncExtraction
-from .resources_aio.watchlist_monitors import WatchlistMonitors as AsyncWatchlistMonitors
-
-class Api:
-    def __init__(self, api_token, region, timeout=None):
-        self.applicant = Applicants(api_token, region, timeout)
-        self.document = Documents(api_token, region, timeout)
-        self.address = Addresses(api_token, region, timeout)
-        self.check = Checks(api_token, region, timeout)
-        self.report = Reports(api_token, region, timeout)
-        self.sdk_token = SdkToken(api_token, region, timeout)
-        self.webhook = Webhooks(api_token, region, timeout)
-        self.live_photo = LivePhotos(api_token, region, timeout)
-        self.live_video = LiveVideos(api_token, region, timeout)
-        self.motion_capture = MotionCaptures(api_token, region, timeout)
-        self.extraction = Extraction(api_token, region, timeout)
-        self.watchlist_monitor = WatchlistMonitors(api_token, region, timeout)
-        self.workflowrun = WorkflowRuns(api_token, region, timeout)
-
-        if region in [Region.EU, Region.US, Region.CA]:
-            pass
-        elif "api.onfido.com" in region:
-            raise OnfidoRegionError("The region must be one of Region.EU, Region.US or Region.CA. We previously defaulted to Region.EU, so if you previously didn’t set a region or used api.onfido.com, please set your region to Region.EU")
-
-class AsyncApi:
-    def __init__(self, api_token, region, aio_session, timeout=None):
-        self.applicant = AsyncApplicants(api_token, region, aio_session, timeout)
-        self.document = AsyncDocuments(api_token, region, aio_session, timeout)
-        self.address = AsyncAddresses(api_token, region, aio_session, timeout)
-        self.check = AsyncChecks(api_token, region, aio_session, timeout)
-        self.report = AsyncReports(api_token, region, aio_session, timeout)
-        self.sdk_token = AsyncSdkToken(api_token, region, aio_session, timeout)
-        self.webhook = AsyncWebhooks(api_token, region, aio_session, timeout)
-        self.live_photo = AsyncLivePhotos(api_token, region, aio_session, timeout)
-        self.live_video = AsyncLiveVideos(api_token, region, aio_session, timeout)
-        self.motion_capture = AsyncMotionCaptures(api_token, region, aio_session, timeout)
-        self.extraction = AsyncExtraction(api_token, region, aio_session, timeout)
-        self.watchlist_monitor = AsyncWatchlistMonitors(api_token, region, aio_session, timeout)
-        self.workflowrun = AsyncWorkflowRuns(api_token, region, aio_session, timeout)
-
-        if region in [Region.EU, Region.US, Region.CA]:
-            pass
-        elif "api.onfido.com" in region:
-            raise OnfidoRegionError("The region must be one of Region.EU, Region.US or Region.CA. We previously defaulted to Region.EU, so if you previously didn’t set a region or used api.onfido.com, please set your region to Region.EU")

onfido/onfido_download.py

@@ -1,11 +0,0 @@
-from aiohttp.client_reqrep import ClientResponse
-
-class OnfidoDownload:
-    def __init__(self, response):
-        self.content = response.content
-        self.content_type = response.headers['content-type']
-
-class OnfidoAioDownload:
-    def __init__(self, response: ClientResponse):
-        self.content = response.content
-        self.content_type = response.content_type

onfido/regions.py

@@ -1,11 +0,0 @@
-from enum import Enum
-
-
-class Region(Enum):
-    EU = "https://api.eu.onfido.com/v3.6/"
-    US = "https://api.us.onfido.com/v3.6/"
-    CA = "https://api.ca.onfido.com/v3.6/"
-
-    @property
-    def region_url(self):
-        return self.value

onfido/resource.py

@@ -1,88 +0,0 @@
-import requests
-from .onfido_download import OnfidoDownload
-from .exceptions import error_decorator, OnfidoUnknownError
-from .mimetype import mimetype_from_name
-from .utils import form_data_converter
-
-try:
-    import importlib.metadata as importlib_metadata
-except ImportError:
-    import importlib_metadata
-
-CURRENT_VERSION = importlib_metadata.version("onfido-python")
-
-class Resource:
-    def __init__(self, api_token, region, timeout):
-        self._api_token = api_token
-        self._region = region
-        self._timeout = timeout
-
-    @property
-    def _url(self):
-        return getattr(self._region, "region_url", self._region)
-
-    def _build_url(self, path):
-        return self._url + path
-
-    @property
-    def _headers(self):
-        return {
-            "User-Agent": f"onfido-python/{CURRENT_VERSION}",
-            "Authorization": f"Token token={self._api_token}"
-        }
-
-    def _handle_response(self, response):
-        response.raise_for_status()
-        if response.status_code == 204:
-            return None
-
-        try:
-            return response.json()
-        except ValueError as e:
-            raise OnfidoUnknownError("Onfido returned invalid JSON") from e
-
-    @error_decorator
-    def _upload_request(self, path, file, **request_body):
-        files = {
-            'file': (file.name, file, mimetype_from_name(file.name))
-        }
-        
-        response = requests.post(self._build_url(path), data=form_data_converter(request_body),
-                                 files=files, headers=self._headers, timeout=self._timeout)
-
-        return self._handle_response(response)
-
-    @error_decorator
-    def _post(self, path, **request_body):
-        response = requests.post(self._build_url(path), json=request_body, headers=self._headers, timeout=self._timeout)
-
-        return self._handle_response(response)
-
-    @error_decorator
-    def _put(self, path, data=None):
-        response = requests.put(self._build_url(path), json=data, headers=self._headers, timeout=self._timeout)
-
-        return self._handle_response(response)
-
-    @error_decorator
-    def _get(self, path, payload=None):
-        response = requests.get(self._build_url(path), headers=self._headers, params=payload, timeout=self._timeout)
-
-        return self._handle_response(response)
-
-    @error_decorator
-    def _download_request(self, path):
-        response = requests.get(self._build_url(path), headers=self._headers, timeout=self._timeout)
-
-        response.raise_for_status()
-
-        try:
-            return OnfidoDownload(response)
-        except ValueError as e:
-            raise OnfidoUnknownError("Onfido returned invalid JSON") from e
-
-    @error_decorator
-    def _delete_request(self, path):
-        response = requests.delete(self._build_url(path), headers=self._headers, timeout=self._timeout)
-
-        return self._handle_response(response)

onfido/resources/address_picker.py

@@ -1,6 +0,0 @@
-from ..resource import Resource
-
-
-class Addresses(Resource):
-    def pick(self, postcode:str):
-        return self._get(f"addresses/pick?postcode={postcode}")

onfido/resources/applicants.py

@@ -1,23 +0,0 @@
-from ..resource import Resource
-
-
-class Applicants(Resource):
-    def create(self, request_body:dict):
-        return self._post("applicants/", **request_body)
-
-    def update(self, applicant_id:str, request_body:dict):
-        return self._put(f"applicants/{applicant_id}", request_body)
-
-    def find(self, applicant_id:str):
-        return self._get(f"applicants/{applicant_id}")
-
-    def delete(self, applicant_id:str):
-        self._delete_request(f"applicants/{applicant_id}")
-
-    def all(self, **user_payload:dict):
-        payload = {"include_deleted": False, "per_page": 20, "page": 1}
-        payload.update(user_payload)
-        return self._get("applicants", payload=payload)
-
-    def restore(self, applicant_id:str):
-        self._post(f"applicants/{applicant_id}/restore")

onfido/resources/checks.py

@@ -1,19 +0,0 @@
-from ..resource import Resource
-
-
-class Checks(Resource):
-    def create(self, request_body:dict):
-        return self._post("checks/", **request_body)
-
-    def find(self, check_id:str):
-        return self._get(f"checks/{check_id}")
-
-    def all(self, applicant_id:str):
-        payload = {"applicant_id": applicant_id}
-        return self._get("checks/", payload=payload)
-
-    def resume(self, check_id:str):
-        self._post(f"checks/{check_id}/resume")
-
-    def download(self, check_id:str):
-        return self._download_request(f"checks/{check_id}/download")

onfido/resources/documents.py

@@ -1,16 +0,0 @@
-from ..resource import Resource
-from typing import BinaryIO
-
-
-class Documents(Resource):
-    def upload(self, sample_file:BinaryIO, request_body):
-        return self._upload_request("documents/", sample_file, **request_body)
-
-    def find(self, document_id:str):
-        return self._get(f"documents/{document_id}")
-
-    def all(self, applicant_id:str):
-        return self._get(f"documents?applicant_id={applicant_id}")
-
-    def download(self, document_id:str):
-        return self._download_request(f"documents/{document_id}/download")

onfido/resources/extraction.py

@@ -1,6 +0,0 @@
-from ..resource import Resource
-
-
-class Extraction(Resource):
-    def perform(self, document_id: str):
-        return self._post("extractions/", document_id=document_id)

onfido/resources/live_photos.py

@@ -1,17 +0,0 @@
-from ..resource import Resource
-from typing import BinaryIO
-
-
-class LivePhotos(Resource):
-    def upload(self, sample_file:BinaryIO, request_body):
-        return self._upload_request("live_photos/", sample_file, **request_body)
-
-    def find(self, live_photo_id:str):
-        return self._get(f"live_photos/{live_photo_id}")
-
-    def all(self, applicant_id:str):
-        payload = {"applicant_id": applicant_id}
-        return self._get("live_photos/", payload=payload)
-
-    def download(self, live_photo_id:str):
-        return self._download_request(f"live_photos/{live_photo_id}/download")

onfido/resources/live_videos.py

@@ -1,16 +0,0 @@
-from ..resource import Resource
-
-
-class LiveVideos(Resource):
-    def find(self, live_video_id:str):
-        return self._get(f"live_videos/{live_video_id}")
-
-    def all(self, applicant_id:str):
-        payload = {"applicant_id": applicant_id}
-        return self._get("live_videos/", payload=payload)
-
-    def download(self, live_video_id:str):
-        return self._download_request(f"live_videos/{live_video_id}/download")
-
-    def download_frame(self, live_video_id:str):
-        return self._download_request(f"live_videos/{live_video_id}/frame")

onfido/resources/motion_captures.py

@@ -1,16 +0,0 @@
-from ..resource import Resource
-
-
-class MotionCaptures(Resource):
-    def find(self, motion_capture_id:str):
-        return self._get(f"motion_captures/{motion_capture_id}")
-
-    def all(self, applicant_id:str):
-        payload = {"applicant_id": applicant_id}
-        return self._get("motion_captures/", payload=payload)
-
-    def download(self, motion_capture_id:str):
-        return self._download_request(f"motion_captures/{motion_capture_id}/download")
-
-    def download_frame(self, motion_capture_id:str):
-        return self._download_request(f"motion_captures/{motion_capture_id}/frame")

onfido/resources/reports.py

@@ -1,16 +0,0 @@
-from ..resource import Resource
-
-
-class Reports(Resource):
-    def find(self, report_id:str):
-        return self._get(f"reports/{report_id}")
-
-    def all(self, check_id:str):
-        payload = {"check_id": check_id}
-        return self._get("reports/", payload=payload)
-
-    def resume(self, report_id:str):
-        return self._post(f"reports/{report_id}/resume")
-
-    def cancel(self, report_id:str):
-        self._post(f"reports/{report_id}/cancel")

onfido/resources/sdk_tokens.py

@@ -1,5 +0,0 @@
-from ..resource import Resource
-
-class SdkToken(Resource):
-    def generate(self, request_body):
-        return self._post("sdk_token", **request_body)

onfido/resources/watchlist_monitors.py

@@ -1,16 +0,0 @@
-from ..resource import Resource
-
-
-class WatchlistMonitors(Resource):
-    def create(self, request_body:dict):
-        return self._post("watchlist_monitors/", **request_body)
-
-    def find(self, monitor_id:str):
-        return self._get(f"watchlist_monitors/{monitor_id}")
-
-    def all(self, applicant_id:str):
-        payload = {"applicant_id": applicant_id}
-        return self._get("watchlist_monitors/", payload=payload)
-  
-    def delete(self, monitor_id:str):
-        self._delete_request(f"watchlist_monitors/{monitor_id}")

onfido/resources/webhooks.py

@@ -1,18 +0,0 @@
-from ..resource import Resource
-
-
-class Webhooks(Resource):
-    def create(self, request_body:dict):
-        return self._post("webhooks", **request_body)
-
-    def all(self):
-        return self._get("webhooks")
-
-    def find(self, webhook_id:str):
-        return self._get(f"webhooks/{webhook_id}")
-
-    def edit(self, webhook_id:str, request_body:dict):
-        return self._put(f"webhooks/{webhook_id}", request_body)
-
-    def delete(self, webhook_id:str):
-        self._delete_request(f"webhooks/{webhook_id}")

onfido/resources/workflow_runs.py

@@ -1,17 +0,0 @@
-from ..resource import Resource
-
-
-class WorkflowRuns(Resource):
-    def create(self, request_body: dict):
-        return self._post("workflow_runs/", **request_body)
-
-    def all(self, **user_payload: dict):
-        payload = {"page": 1, "sort": "desc"}
-        payload.update(user_payload)
-        return self._get("workflow_runs", payload=payload)
-
-    def find(self, workflow_run_id: str):
-        return self._get(f"workflow_runs/{workflow_run_id}")
-
-    def evidence(self, workflow_run_id: str):
-        return self._download_request(f"workflow_runs/{workflow_run_id}/signed_evidence_file")

onfido/resources_aio/address_picker.py

@@ -1,6 +0,0 @@
-from ..aio_resource import Resource
-
-
-class Addresses(Resource):
-    def pick(self, postcode: str):
-        return self._get(f"addresses/pick?postcode={postcode}")

onfido/resources_aio/applicants.py

@@ -1,23 +0,0 @@
-from ..aio_resource import Resource
-
-
-class Applicants(Resource):
-    def create(self, request_body: dict):
-        return self._post("applicants/", **request_body)
-
-    def update(self, applicant_id: str, request_body: dict):
-        return self._put(f"applicants/{applicant_id}", request_body)
-
-    def find(self, applicant_id: str):
-        return self._get(f"applicants/{applicant_id}")
-
-    def delete(self, applicant_id: str):
-        return self._delete_request(f"applicants/{applicant_id}")
-
-    def all(self, **user_payload: dict):
-        payload = {"include_deleted": False, "per_page": 20, "page": 1}
-        payload.update(user_payload)
-        return self._get("applicants", payload=payload)
-
-    def restore(self, applicant_id: str):
-        return self._post(f"applicants/{applicant_id}/restore")

onfido/resources_aio/checks.py

@@ -1,19 +0,0 @@
-from ..aio_resource import Resource
-
-
-class Checks(Resource):
-    def create(self, request_body: dict):
-        return self._post("checks/", **request_body)
-
-    def find(self, check_id: str):
-        return self._get(f"checks/{check_id}")
-
-    def all(self, applicant_id: str):
-        payload = {"applicant_id": applicant_id}
-        return self._get("checks/", payload=payload)
-
-    def resume(self, check_id: str):
-        return self._post(f"checks/{check_id}/resume")
-
-    def download(self, check_id: str):
-        return self._download_request(f"checks/{check_id}/download")

onfido/resources_aio/documents.py

@@ -1,16 +0,0 @@
-from ..aio_resource import Resource
-from typing import BinaryIO
-
-
-class Documents(Resource):
-    def upload(self, sample_file: BinaryIO, request_body):
-        return self._upload_request("documents/", sample_file, **request_body)
-
-    def find(self, document_id: str):
-        return self._get(f"documents/{document_id}")
-
-    def all(self, applicant_id: str):
-        return self._get(f"documents?applicant_id={applicant_id}")
-
-    def download(self, document_id: str):
-        return self._download_request(f"documents/{document_id}/download")

onfido/resources_aio/extraction.py

@@ -1,6 +0,0 @@
-from ..aio_resource import Resource
-
-
-class Extraction(Resource):
-    def perform(self, document_id: str):
-        return self._post("extractions/", document_id=document_id)

onfido/resources_aio/live_photos.py

@@ -1,17 +0,0 @@
-from ..aio_resource import Resource
-from typing import BinaryIO
-
-
-class LivePhotos(Resource):
-    def upload(self, sample_file: BinaryIO, request_body):
-        return self._upload_request("live_photos/", sample_file, **request_body)
-
-    def find(self, live_photo_id: str):
-        return self._get(f"live_photos/{live_photo_id}")
-
-    def all(self, applicant_id: str):
-        payload = {"applicant_id": applicant_id}
-        return self._get("live_photos/", payload=payload)
-
-    def download(self, live_photo_id: str):
-        return self._download_request(f"live_photos/{live_photo_id}/download")

onfido/resources_aio/live_videos.py

@@ -1,16 +0,0 @@
-from ..aio_resource import Resource
-
-
-class LiveVideos(Resource):
-    def find(self, live_video_id: str):
-        return self._get(f"live_videos/{live_video_id}")
-
-    def all(self, applicant_id: str):
-        payload = {"applicant_id": applicant_id}
-        return self._get("live_videos/", payload=payload)
-
-    def download(self, live_video_id: str):
-        return self._download_request(f"live_videos/{live_video_id}/download")
-
-    def download_frame(self, live_video_id: str):
-        return self._download_request(f"live_videos/{live_video_id}/frame")

onfido/resources_aio/motion_captures.py

@@ -1,16 +0,0 @@
-from ..aio_resource import Resource
-
-
-class MotionCaptures(Resource):
-    def find(self, motion_capture_id: str):
-        return self._get(f"motion_captures/{motion_capture_id}")
-
-    def all(self, applicant_id: str):
-        payload = {"applicant_id": applicant_id}
-        return self._get("motion_captures/", payload=payload)
-
-    def download(self, motion_capture_id: str):
-        return self._download_request(f"motion_captures/{motion_capture_id}/download")
-
-    def download_frame(self, motion_capture_id: str):
-        return self._download_request(f"motion_captures/{motion_capture_id}/frame")