handset 0.1.1__py3-none-any.whl

handset/__init__.py

@@ -0,0 +1,8 @@
+
+""" A client library for accessing Handset API """
+from .client import AuthenticatedClient, Client
+
+__all__ = (
+    "AuthenticatedClient",
+    "Client",
+)

handset/api/__init__.py

@@ -0,0 +1 @@
+""" Contains methods for accessing the API """

handset/api/compliance/__init__.py

@@ -0,0 +1 @@
+""" Contains endpoint functions for accessing the API """

handset/api/compliance/create_brand.py

@@ -0,0 +1,210 @@
+from http import HTTPStatus
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.brand import Brand
+from ...models.brand_create import BrandCreate
+from ...models.error_body import ErrorBody
+from ...types import UNSET, Unset
+from typing import cast
+
+
+
+def _get_kwargs(
+    *,
+    body: BrandCreate,
+    idempotency_key: str | Unset = UNSET,
+
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+    if not isinstance(idempotency_key, Unset):
+        headers["Idempotency-Key"] = idempotency_key
+
+
+
+    
+
+    
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/brands",
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Brand | ErrorBody:
+    if response.status_code == 201:
+        response_201 = Brand.from_dict(response.json())
+
+
+
+        return response_201
+
+    response_default = ErrorBody.from_dict(response.json())
+
+
+
+    return response_default
+
+
+
+def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Response[Brand | ErrorBody]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    body: BrandCreate,
+    idempotency_key: str | Unset = UNSET,
+
+) -> Response[Brand | ErrorBody]:
+    """ Register a 10DLC brand
+
+     Registers your platform (or a tenant, for tenants with their own EIN) with The Campaign Registry.
+    Vetting typically takes minutes to days; track via `brand.status_changed`.
+
+    Args:
+        idempotency_key (str | Unset):
+        body (BrandCreate):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Brand | ErrorBody]
+     """
+
+
+    kwargs = _get_kwargs(
+        body=body,
+idempotency_key=idempotency_key,
+
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+def sync(
+    *,
+    client: AuthenticatedClient | Client,
+    body: BrandCreate,
+    idempotency_key: str | Unset = UNSET,
+
+) -> Brand | ErrorBody | None:
+    """ Register a 10DLC brand
+
+     Registers your platform (or a tenant, for tenants with their own EIN) with The Campaign Registry.
+    Vetting typically takes minutes to days; track via `brand.status_changed`.
+
+    Args:
+        idempotency_key (str | Unset):
+        body (BrandCreate):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Brand | ErrorBody
+     """
+
+
+    return sync_detailed(
+        client=client,
+body=body,
+idempotency_key=idempotency_key,
+
+    ).parsed
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    body: BrandCreate,
+    idempotency_key: str | Unset = UNSET,
+
+) -> Response[Brand | ErrorBody]:
+    """ Register a 10DLC brand
+
+     Registers your platform (or a tenant, for tenants with their own EIN) with The Campaign Registry.
+    Vetting typically takes minutes to days; track via `brand.status_changed`.
+
+    Args:
+        idempotency_key (str | Unset):
+        body (BrandCreate):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Brand | ErrorBody]
+     """
+
+
+    kwargs = _get_kwargs(
+        body=body,
+idempotency_key=idempotency_key,
+
+    )
+
+    response = await client.get_async_httpx_client().request(
+        **kwargs
+    )
+
+    return _build_response(client=client, response=response)
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient | Client,
+    body: BrandCreate,
+    idempotency_key: str | Unset = UNSET,
+
+) -> Brand | ErrorBody | None:
+    """ Register a 10DLC brand
+
+     Registers your platform (or a tenant, for tenants with their own EIN) with The Campaign Registry.
+    Vetting typically takes minutes to days; track via `brand.status_changed`.
+
+    Args:
+        idempotency_key (str | Unset):
+        body (BrandCreate):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Brand | ErrorBody
+     """
+
+
+    return (await asyncio_detailed(
+        client=client,
+body=body,
+idempotency_key=idempotency_key,
+
+    )).parsed

handset/api/compliance/create_campaign.py

@@ -0,0 +1,214 @@
+from http import HTTPStatus
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.campaign import Campaign
+from ...models.campaign_create import CampaignCreate
+from ...models.error_body import ErrorBody
+from ...types import UNSET, Unset
+from typing import cast
+
+
+
+def _get_kwargs(
+    *,
+    body: CampaignCreate,
+    idempotency_key: str | Unset = UNSET,
+
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+    if not isinstance(idempotency_key, Unset):
+        headers["Idempotency-Key"] = idempotency_key
+
+
+
+    
+
+    
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/campaigns",
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Campaign | ErrorBody:
+    if response.status_code == 201:
+        response_201 = Campaign.from_dict(response.json())
+
+
+
+        return response_201
+
+    response_default = ErrorBody.from_dict(response.json())
+
+
+
+    return response_default
+
+
+
+def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Response[Campaign | ErrorBody]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    body: CampaignCreate,
+    idempotency_key: str | Unset = UNSET,
+
+) -> Response[Campaign | ErrorBody]:
+    """ Register a 10DLC campaign
+
+     Registers a messaging use case under an approved brand for a tenant. Carrier review typically takes
+    1–3 business days; sending is blocked until status is `approved`. Track via
+    `campaign.status_changed`.
+
+    Args:
+        idempotency_key (str | Unset):
+        body (CampaignCreate):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Campaign | ErrorBody]
+     """
+
+
+    kwargs = _get_kwargs(
+        body=body,
+idempotency_key=idempotency_key,
+
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+def sync(
+    *,
+    client: AuthenticatedClient | Client,
+    body: CampaignCreate,
+    idempotency_key: str | Unset = UNSET,
+
+) -> Campaign | ErrorBody | None:
+    """ Register a 10DLC campaign
+
+     Registers a messaging use case under an approved brand for a tenant. Carrier review typically takes
+    1–3 business days; sending is blocked until status is `approved`. Track via
+    `campaign.status_changed`.
+
+    Args:
+        idempotency_key (str | Unset):
+        body (CampaignCreate):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Campaign | ErrorBody
+     """
+
+
+    return sync_detailed(
+        client=client,
+body=body,
+idempotency_key=idempotency_key,
+
+    ).parsed
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    body: CampaignCreate,
+    idempotency_key: str | Unset = UNSET,
+
+) -> Response[Campaign | ErrorBody]:
+    """ Register a 10DLC campaign
+
+     Registers a messaging use case under an approved brand for a tenant. Carrier review typically takes
+    1–3 business days; sending is blocked until status is `approved`. Track via
+    `campaign.status_changed`.
+
+    Args:
+        idempotency_key (str | Unset):
+        body (CampaignCreate):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[Campaign | ErrorBody]
+     """
+
+
+    kwargs = _get_kwargs(
+        body=body,
+idempotency_key=idempotency_key,
+
+    )
+
+    response = await client.get_async_httpx_client().request(
+        **kwargs
+    )
+
+    return _build_response(client=client, response=response)
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient | Client,
+    body: CampaignCreate,
+    idempotency_key: str | Unset = UNSET,
+
+) -> Campaign | ErrorBody | None:
+    """ Register a 10DLC campaign
+
+     Registers a messaging use case under an approved brand for a tenant. Carrier review typically takes
+    1–3 business days; sending is blocked until status is `approved`. Track via
+    `campaign.status_changed`.
+
+    Args:
+        idempotency_key (str | Unset):
+        body (CampaignCreate):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Campaign | ErrorBody
+     """
+
+
+    return (await asyncio_detailed(
+        client=client,
+body=body,
+idempotency_key=idempotency_key,
+
+    )).parsed

handset/api/compliance/create_e911_address.py

@@ -0,0 +1,210 @@
+from http import HTTPStatus
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.e911_address import E911Address
+from ...models.e911_address_create import E911AddressCreate
+from ...models.error_body import ErrorBody
+from ...types import UNSET, Unset
+from typing import cast
+
+
+
+def _get_kwargs(
+    *,
+    body: E911AddressCreate,
+    idempotency_key: str | Unset = UNSET,
+
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+    if not isinstance(idempotency_key, Unset):
+        headers["Idempotency-Key"] = idempotency_key
+
+
+
+    
+
+    
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/e911_addresses",
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> E911Address | ErrorBody:
+    if response.status_code == 201:
+        response_201 = E911Address.from_dict(response.json())
+
+
+
+        return response_201
+
+    response_default = ErrorBody.from_dict(response.json())
+
+
+
+    return response_default
+
+
+
+def _build_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Response[E911Address | ErrorBody]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    body: E911AddressCreate,
+    idempotency_key: str | Unset = UNSET,
+
+) -> Response[E911Address | ErrorBody]:
+    """ Validate and register an E911 address
+
+     Validates a dispatchable location and registers it for use with a tenant's numbers. Returns
+    `e911_address_invalid` with correction suggestions when validation fails.
+
+    Args:
+        idempotency_key (str | Unset):
+        body (E911AddressCreate):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[E911Address | ErrorBody]
+     """
+
+
+    kwargs = _get_kwargs(
+        body=body,
+idempotency_key=idempotency_key,
+
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+def sync(
+    *,
+    client: AuthenticatedClient | Client,
+    body: E911AddressCreate,
+    idempotency_key: str | Unset = UNSET,
+
+) -> E911Address | ErrorBody | None:
+    """ Validate and register an E911 address
+
+     Validates a dispatchable location and registers it for use with a tenant's numbers. Returns
+    `e911_address_invalid` with correction suggestions when validation fails.
+
+    Args:
+        idempotency_key (str | Unset):
+        body (E911AddressCreate):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        E911Address | ErrorBody
+     """
+
+
+    return sync_detailed(
+        client=client,
+body=body,
+idempotency_key=idempotency_key,
+
+    ).parsed
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    body: E911AddressCreate,
+    idempotency_key: str | Unset = UNSET,
+
+) -> Response[E911Address | ErrorBody]:
+    """ Validate and register an E911 address
+
+     Validates a dispatchable location and registers it for use with a tenant's numbers. Returns
+    `e911_address_invalid` with correction suggestions when validation fails.
+
+    Args:
+        idempotency_key (str | Unset):
+        body (E911AddressCreate):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        Response[E911Address | ErrorBody]
+     """
+
+
+    kwargs = _get_kwargs(
+        body=body,
+idempotency_key=idempotency_key,
+
+    )
+
+    response = await client.get_async_httpx_client().request(
+        **kwargs
+    )
+
+    return _build_response(client=client, response=response)
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient | Client,
+    body: E911AddressCreate,
+    idempotency_key: str | Unset = UNSET,
+
+) -> E911Address | ErrorBody | None:
+    """ Validate and register an E911 address
+
+     Validates a dispatchable location and registers it for use with a tenant's numbers. Returns
+    `e911_address_invalid` with correction suggestions when validation fails.
+
+    Args:
+        idempotency_key (str | Unset):
+        body (E911AddressCreate):
+
+    Raises:
+        errors.UnexpectedStatus: If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
+        httpx.TimeoutException: If the request takes longer than Client.timeout.
+
+    Returns:
+        E911Address | ErrorBody
+     """
+
+
+    return (await asyncio_detailed(
+        client=client,
+body=body,
+idempotency_key=idempotency_key,
+
+    )).parsed