prelude-python-sdk 0.1.0a3__py3-none-any.whl

prelude_python_sdk/types/verification_check_params.py

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["VerificationCheckParams", "Target"]
+
+
+class VerificationCheckParams(TypedDict, total=False):
+    code: Required[str]
+    """The OTP code to validate."""
+
+    target: Required[Target]
+    """The target. Currently this can only be an E.164 formatted phone number."""
+
+
+class Target(TypedDict, total=False):
+    type: Required[Literal["phone_number"]]
+    """The type of the target. Currently this can only be "phone_number"."""
+
+    value: Required[str]
+    """An E.164 formatted phone number to verify."""

prelude_python_sdk/types/verification_check_response.py

@@ -0,0 +1,25 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["VerificationCheckResponse", "Metadata"]
+
+
+class Metadata(BaseModel):
+    correlation_id: Optional[str] = None
+
+
+class VerificationCheckResponse(BaseModel):
+    id: Optional[str] = None
+    """The verification identifier."""
+
+    metadata: Optional[Metadata] = None
+    """The metadata for this verification."""
+
+    request_id: Optional[str] = None
+
+    status: Optional[Literal["success", "failure", "expired"]] = None
+    """The status of the check."""

prelude_python_sdk/types/verification_create_params.py

@@ -0,0 +1,98 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["VerificationCreateParams", "Target", "Metadata", "Options", "Signals"]
+
+
+class VerificationCreateParams(TypedDict, total=False):
+    target: Required[Target]
+    """The target. Currently this can only be an E.164 formatted phone number."""
+
+    metadata: Metadata
+    """The metadata for this verification.
+
+    This object will be returned with every response or webhook sent that refers to
+    this verification.
+    """
+
+    options: Options
+    """Verification options"""
+
+    signals: Signals
+    """The signals used for anti-fraud."""
+
+
+class Target(TypedDict, total=False):
+    type: Required[Literal["phone_number"]]
+    """The type of the target. Currently this can only be "phone_number"."""
+
+    value: Required[str]
+    """An E.164 formatted phone number to verify."""
+
+
+class Metadata(TypedDict, total=False):
+    correlation_id: str
+    """A user-defined identifier to correlate this verification with."""
+
+
+class Options(TypedDict, total=False):
+    app_realm: str
+    """The Android SMS Retriever API hash code that identifies your app.
+
+    This allows you to automatically retrieve and fill the OTP code on Android
+    devices.
+    """
+
+    locale: str
+    """
+    A BCP-47 formatted locale string with the language the text message will be sent
+    to. If there's no locale set, the language will be determined by the country
+    code of the phone number. If the language specified doesn't exist, it defaults
+    to US English.
+    """
+
+    sender_id: str
+    """The Sender ID to use for this message.
+
+    The Sender ID needs to be enabled by Prelude.
+    """
+
+    template_id: str
+    """The identifier of a verification settings template.
+
+    It is used to be able to switch behavior for specific use cases. Contact us if
+    you need to use this functionality.
+    """
+
+
+class Signals(TypedDict, total=False):
+    app_version: str
+    """The version of your application."""
+
+    device_id: str
+    """The unique identifier for the user's device.
+
+    For Android, this corresponds to the `ANDROID_ID` and for iOS, this corresponds
+    to the `identifierForVendor`.
+    """
+
+    device_model: str
+    """The model of the user's device."""
+
+    device_platform: Literal["android", "ios", "web"]
+    """The type of the user's device."""
+
+    ip: str
+    """The IP address of the user's device."""
+
+    is_trusted_user: str
+    """
+    This signal should provide a higher level of trust, indicating that the user is
+    genuine. For more details, refer to [Signals](/guides/prevent-fraud#signals).
+    """
+
+    os_version: str
+    """The version of the user's device operating system."""

prelude_python_sdk/types/verification_create_response.py

@@ -0,0 +1,28 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["VerificationCreateResponse", "Metadata"]
+
+
+class Metadata(BaseModel):
+    correlation_id: Optional[str] = None
+
+
+class VerificationCreateResponse(BaseModel):
+    id: Optional[str] = None
+    """The verification identifier."""
+
+    metadata: Optional[Metadata] = None
+    """The metadata for this verification."""
+
+    method: Optional[Literal["message"]] = None
+    """The method used for verifying this phone number."""
+
+    request_id: Optional[str] = None
+
+    status: Optional[Literal["success", "retry", "blocked"]] = None
+    """The status of the verification."""

prelude_python_sdk/types/watch_feed_back_params.py

@@ -0,0 +1,34 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["WatchFeedBackParams", "Feedback", "Target"]
+
+
+class WatchFeedBackParams(TypedDict, total=False):
+    feedback: Required[Feedback]
+    """
+    You should send a feedback event back to Watch API when your user demonstrates
+    authentic behavior.
+    """
+
+    target: Required[Target]
+    """The target. Currently this can only be an E.164 formatted phone number."""
+
+
+class Feedback(TypedDict, total=False):
+    type: Required[Literal["CONFIRM_TARGET"]]
+    """
+    `CONFIRM_TARGET` should be sent when you are sure that the user with this target
+    (e.g. phone number) is trustworthy.
+    """
+
+
+class Target(TypedDict, total=False):
+    type: Required[Literal["phone_number"]]
+    """The type of the target. Currently this can only be "phone_number"."""
+
+    value: Required[str]
+    """An E.164 formatted phone number to verify."""

prelude_python_sdk/types/watch_feed_back_response.py

@@ -0,0 +1,12 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+
+from .._models import BaseModel
+
+__all__ = ["WatchFeedBackResponse"]
+
+
+class WatchFeedBackResponse(BaseModel):
+    id: Optional[str] = None
+    """A unique identifier for your feedback request."""

prelude_python_sdk/types/watch_predict_params.py

@@ -0,0 +1,44 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Literal, Required, TypedDict
+
+__all__ = ["WatchPredictParams", "Target", "Signals"]
+
+
+class WatchPredictParams(TypedDict, total=False):
+    target: Required[Target]
+    """The target. Currently this can only be an E.164 formatted phone number."""
+
+    signals: Signals
+    """
+    It is highly recommended that you provide the signals to increase prediction
+    performance.
+    """
+
+
+class Target(TypedDict, total=False):
+    type: Required[Literal["phone_number"]]
+    """The type of the target. Currently this can only be "phone_number"."""
+
+    value: Required[str]
+    """An E.164 formatted phone number to verify."""
+
+
+class Signals(TypedDict, total=False):
+    device_id: str
+    """The unique identifier for the user's device.
+
+    For Android, this corresponds to the `ANDROID_ID` and for iOS, this corresponds
+    to the `identifierForVendor`.
+    """
+
+    device_model: str
+    """The model of the user's device."""
+
+    device_type: str
+    """The type of the user's device."""
+
+    ip: str
+    """The IPv4 address of the user's device"""

prelude_python_sdk/types/watch_predict_response.py

@@ -0,0 +1,29 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Optional
+from typing_extensions import Literal
+
+from .._models import BaseModel
+
+__all__ = ["WatchPredictResponse", "Reasoning"]
+
+
+class Reasoning(BaseModel):
+    cause: Optional[Literal["none", "smart_antifraud", "repeat_number", "invalid_line"]] = None
+    """A label explaining why the phone number was classified as not trustworthy"""
+
+    score: Optional[float] = None
+    """
+    Indicates the risk of the phone number being genuine or involved in fraudulent
+    patterns. The higher the riskier.
+    """
+
+
+class WatchPredictResponse(BaseModel):
+    id: Optional[str] = None
+    """A unique identifier for your prediction request."""
+
+    prediction: Optional[Literal["allow", "block"]] = None
+    """A label indicating the trustworthiness of the phone number."""
+
+    reasoning: Optional[Reasoning] = None

prelude_python_sdk-0.1.0a3.dist-info/METADATA

@@ -0,0 +1,386 @@
+Metadata-Version: 2.3
+Name: prelude-python-sdk
+Version: 0.1.0a3
+Summary: The official Python library for the Prelude API
+Project-URL: Homepage, https://github.com/prelude-so/python-sdk
+Project-URL: Repository, https://github.com/prelude-so/python-sdk
+Author-email: Prelude <hello@prelude.so>
+License: Apache-2.0
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+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 :: 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-Python: >=3.8
+Requires-Dist: anyio<5,>=3.5.0
+Requires-Dist: cached-property; python_version < '3.8'
+Requires-Dist: distro<2,>=1.7.0
+Requires-Dist: httpx<1,>=0.23.0
+Requires-Dist: pydantic<3,>=1.9.0
+Requires-Dist: sniffio
+Requires-Dist: typing-extensions<5,>=4.7
+Description-Content-Type: text/markdown
+
+# Prelude Python API library
+
+[![PyPI version](https://img.shields.io/pypi/v/prelude-python-sdk.svg)](https://pypi.org/project/prelude-python-sdk/)
+
+The Prelude Python library provides convenient access to the Prelude REST API from any Python 3.8+
+application. The library includes type definitions for all request params and response fields,
+and offers both synchronous and asynchronous clients powered by [httpx](https://github.com/encode/httpx).
+
+It is generated with [Stainless](https://www.stainlessapi.com/).
+
+## Documentation
+
+The REST API documentation can be found on [docs.prelude.so](https://docs.prelude.so). The full API of this library can be found in [api.md](https://github.com/prelude-so/python-sdk/tree/main/api.md).
+
+## Installation
+
+```sh
+# install from PyPI
+pip install --pre prelude-python-sdk
+```
+
+## Usage
+
+The full API of this library can be found in [api.md](https://github.com/prelude-so/python-sdk/tree/main/api.md).
+
+```python
+import os
+from prelude_python_sdk import Prelude
+
+client = Prelude(
+    api_token=os.environ.get("API_TOKEN"),  # This is the default and can be omitted
+)
+
+verification = client.verification.create(
+    target={
+        "type": "phone_number",
+        "value": "+30123456789",
+    },
+)
+print(verification.id)
+```
+
+While you can provide a `api_token` keyword argument,
+we recommend using [python-dotenv](https://pypi.org/project/python-dotenv/)
+to add `API_TOKEN="My API Token"` to your `.env` file
+so that your API Token is not stored in source control.
+
+## Async usage
+
+Simply import `AsyncPrelude` instead of `Prelude` and use `await` with each API call:
+
+```python
+import os
+import asyncio
+from prelude_python_sdk import AsyncPrelude
+
+client = AsyncPrelude(
+    api_token=os.environ.get("API_TOKEN"),  # This is the default and can be omitted
+)
+
+
+async def main() -> None:
+    verification = await client.verification.create(
+        target={
+            "type": "phone_number",
+            "value": "+30123456789",
+        },
+    )
+    print(verification.id)
+
+
+asyncio.run(main())
+```
+
+Functionality between the synchronous and asynchronous clients is otherwise identical.
+
+## Using types
+
+Nested request parameters are [TypedDicts](https://docs.python.org/3/library/typing.html#typing.TypedDict). Responses are [Pydantic models](https://docs.pydantic.dev) which also provide helper methods for things like:
+
+- Serializing back into JSON, `model.to_json()`
+- Converting to a dictionary, `model.to_dict()`
+
+Typed requests and responses provide autocomplete and documentation within your editor. If you would like to see type errors in VS Code to help catch bugs earlier, set `python.analysis.typeCheckingMode` to `basic`.
+
+## Handling errors
+
+When the library is unable to connect to the API (for example, due to network connection problems or a timeout), a subclass of `prelude_python_sdk.APIConnectionError` is raised.
+
+When the API returns a non-success status code (that is, 4xx or 5xx
+response), a subclass of `prelude_python_sdk.APIStatusError` is raised, containing `status_code` and `response` properties.
+
+All errors inherit from `prelude_python_sdk.APIError`.
+
+```python
+import prelude_python_sdk
+from prelude_python_sdk import Prelude
+
+client = Prelude()
+
+try:
+    client.verification.create(
+        target={
+            "type": "phone_number",
+            "value": "+30123456789",
+        },
+    )
+except prelude_python_sdk.APIConnectionError as e:
+    print("The server could not be reached")
+    print(e.__cause__)  # an underlying Exception, likely raised within httpx.
+except prelude_python_sdk.RateLimitError as e:
+    print("A 429 status code was received; we should back off a bit.")
+except prelude_python_sdk.APIStatusError as e:
+    print("Another non-200-range status code was received")
+    print(e.status_code)
+    print(e.response)
+```
+
+Error codes are as followed:
+
+| Status Code | Error Type                 |
+| ----------- | -------------------------- |
+| 400         | `BadRequestError`          |
+| 401         | `AuthenticationError`      |
+| 403         | `PermissionDeniedError`    |
+| 404         | `NotFoundError`            |
+| 422         | `UnprocessableEntityError` |
+| 429         | `RateLimitError`           |
+| >=500       | `InternalServerError`      |
+| N/A         | `APIConnectionError`       |
+
+### Retries
+
+Certain errors are automatically retried 2 times by default, with a short exponential backoff.
+Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,
+429 Rate Limit, and >=500 Internal errors are all retried by default.
+
+You can use the `max_retries` option to configure or disable retry settings:
+
+```python
+from prelude_python_sdk import Prelude
+
+# Configure the default for all requests:
+client = Prelude(
+    # default is 2
+    max_retries=0,
+)
+
+# Or, configure per-request:
+client.with_options(max_retries=5).verification.create(
+    target={
+        "type": "phone_number",
+        "value": "+30123456789",
+    },
+)
+```
+
+### Timeouts
+
+By default requests time out after 1 minute. You can configure this with a `timeout` option,
+which accepts a float or an [`httpx.Timeout`](https://www.python-httpx.org/advanced/#fine-tuning-the-configuration) object:
+
+```python
+from prelude_python_sdk import Prelude
+
+# Configure the default for all requests:
+client = Prelude(
+    # 20 seconds (default is 1 minute)
+    timeout=20.0,
+)
+
+# More granular control:
+client = Prelude(
+    timeout=httpx.Timeout(60.0, read=5.0, write=10.0, connect=2.0),
+)
+
+# Override per-request:
+client.with_options(timeout=5.0).verification.create(
+    target={
+        "type": "phone_number",
+        "value": "+30123456789",
+    },
+)
+```
+
+On timeout, an `APITimeoutError` is thrown.
+
+Note that requests that time out are [retried twice by default](https://github.com/prelude-so/python-sdk/tree/main/#retries).
+
+## Advanced
+
+### Logging
+
+We use the standard library [`logging`](https://docs.python.org/3/library/logging.html) module.
+
+You can enable logging by setting the environment variable `PRELUDE_LOG` to `debug`.
+
+```shell
+$ export PRELUDE_LOG=debug
+```
+
+### How to tell whether `None` means `null` or missing
+
+In an API response, a field may be explicitly `null`, or missing entirely; in either case, its value is `None` in this library. You can differentiate the two cases with `.model_fields_set`:
+
+```py
+if response.my_field is None:
+  if 'my_field' not in response.model_fields_set:
+    print('Got json like {}, without a "my_field" key present at all.')
+  else:
+    print('Got json like {"my_field": null}.')
+```
+
+### Accessing raw response data (e.g. headers)
+
+The "raw" Response object can be accessed by prefixing `.with_raw_response.` to any HTTP method call, e.g.,
+
+```py
+from prelude_python_sdk import Prelude
+
+client = Prelude()
+response = client.verification.with_raw_response.create(
+    target={
+        "type": "phone_number",
+        "value": "+30123456789",
+    },
+)
+print(response.headers.get('X-My-Header'))
+
+verification = response.parse()  # get the object that `verification.create()` would have returned
+print(verification.id)
+```
+
+These methods return an [`APIResponse`](https://github.com/prelude-so/python-sdk/tree/main/src/prelude_python_sdk/_response.py) object.
+
+The async client returns an [`AsyncAPIResponse`](https://github.com/prelude-so/python-sdk/tree/main/src/prelude_python_sdk/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
+
+#### `.with_streaming_response`
+
+The above interface eagerly reads the full response body when you make the request, which may not always be what you want.
+
+To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
+
+```python
+with client.verification.with_streaming_response.create(
+    target={
+        "type": "phone_number",
+        "value": "+30123456789",
+    },
+) as response:
+    print(response.headers.get("X-My-Header"))
+
+    for line in response.iter_lines():
+        print(line)
+```
+
+The context manager is required so that the response will reliably be closed.
+
+### Making custom/undocumented requests
+
+This library is typed for convenient access to the documented API.
+
+If you need to access undocumented endpoints, params, or response properties, the library can still be used.
+
+#### Undocumented endpoints
+
+To make requests to undocumented endpoints, you can make requests using `client.get`, `client.post`, and other
+http verbs. Options on the client will be respected (such as retries) will be respected when making this
+request.
+
+```py
+import httpx
+
+response = client.post(
+    "/foo",
+    cast_to=httpx.Response,
+    body={"my_param": True},
+)
+
+print(response.headers.get("x-foo"))
+```
+
+#### Undocumented request params
+
+If you want to explicitly send an extra param, you can do so with the `extra_query`, `extra_body`, and `extra_headers` request
+options.
+
+#### Undocumented response properties
+
+To access undocumented response properties, you can access the extra fields like `response.unknown_prop`. You
+can also get all the extra fields on the Pydantic model as a dict with
+[`response.model_extra`](https://docs.pydantic.dev/latest/api/base_model/#pydantic.BaseModel.model_extra).
+
+### Configuring the HTTP client
+
+You can directly override the [httpx client](https://www.python-httpx.org/api/#client) to customize it for your use case, including:
+
+- Support for proxies
+- Custom transports
+- Additional [advanced](https://www.python-httpx.org/advanced/clients/) functionality
+
+```python
+from prelude_python_sdk import Prelude, DefaultHttpxClient
+
+client = Prelude(
+    # Or use the `PRELUDE_BASE_URL` env var
+    base_url="http://my.test.server.example.com:8083",
+    http_client=DefaultHttpxClient(
+        proxies="http://my.test.proxy.example.com",
+        transport=httpx.HTTPTransport(local_address="0.0.0.0"),
+    ),
+)
+```
+
+You can also customize the client on a per-request basis by using `with_options()`:
+
+```python
+client.with_options(http_client=DefaultHttpxClient(...))
+```
+
+### Managing HTTP resources
+
+By default the library closes underlying HTTP connections whenever the client is [garbage collected](https://docs.python.org/3/reference/datamodel.html#object.__del__). You can manually close the client using the `.close()` method if desired, or with a context manager that closes when exiting.
+
+## Versioning
+
+This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:
+
+1. Changes that only affect static types, without breaking runtime behavior.
+2. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals)_.
+3. Changes that we do not expect to impact the vast majority of users in practice.
+
+We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
+
+We are keen for your feedback; please open an [issue](https://www.github.com/prelude-so/python-sdk/issues) with questions, bugs, or suggestions.
+
+### Determining the installed version
+
+If you've upgraded to the latest version but aren't seeing any new features you were expecting then your python environment is likely still using an older version.
+
+You can determine the version that is being used at runtime with:
+
+```py
+import prelude_python_sdk
+print(prelude_python_sdk.__version__)
+```
+
+## Requirements
+
+Python 3.8 or higher.
+
+## Contributing
+
+See [the contributing documentation](https://github.com/prelude-so/python-sdk/tree/main/./CONTRIBUTING.md).