blink-api-client 1.0.11__py3-none-any.whl

blink_api_client/__init__.py

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

blink_api_client/api/__init__.py

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

blink_api_client/api/affiliates/__init__.py

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

blink_api_client/api/affiliates/get_affiliates.py

@@ -0,0 +1,214 @@
+from http import HTTPStatus
+from typing import Any, cast
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.affiliates_list_response import AffiliatesListResponse
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    *,
+    status: str | Unset = UNSET,
+    limit: int | Unset = 10,
+    page: int | Unset = 1,
+) -> dict[str, Any]:
+
+    params: dict[str, Any] = {}
+
+    params["status"] = status
+
+    params["limit"] = limit
+
+    params["page"] = page
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/affiliates",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> AffiliatesListResponse | Any | None:
+    if response.status_code == 200:
+        response_200 = AffiliatesListResponse.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 401:
+        response_401 = cast(Any, None)
+        return response_401
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[AffiliatesListResponse | Any]:
+    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,
+    status: str | Unset = UNSET,
+    limit: int | Unset = 10,
+    page: int | Unset = 1,
+) -> Response[AffiliatesListResponse | Any]:
+    """List affiliates
+
+     Retrieves a list of affiliates for a store, with optional filtering by status and pagination
+    support.
+
+    **Usage:** Analyze and manage affiliates for promotional strategies.
+
+    Args:
+        status (str | Unset):
+        limit (int | Unset):  Default: 10.
+        page (int | Unset):  Default: 1.
+
+    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[AffiliatesListResponse | Any]
+    """
+
+    kwargs = _get_kwargs(
+        status=status,
+        limit=limit,
+        page=page,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient | Client,
+    status: str | Unset = UNSET,
+    limit: int | Unset = 10,
+    page: int | Unset = 1,
+) -> AffiliatesListResponse | Any | None:
+    """List affiliates
+
+     Retrieves a list of affiliates for a store, with optional filtering by status and pagination
+    support.
+
+    **Usage:** Analyze and manage affiliates for promotional strategies.
+
+    Args:
+        status (str | Unset):
+        limit (int | Unset):  Default: 10.
+        page (int | Unset):  Default: 1.
+
+    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:
+        AffiliatesListResponse | Any
+    """
+
+    return sync_detailed(
+        client=client,
+        status=status,
+        limit=limit,
+        page=page,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    status: str | Unset = UNSET,
+    limit: int | Unset = 10,
+    page: int | Unset = 1,
+) -> Response[AffiliatesListResponse | Any]:
+    """List affiliates
+
+     Retrieves a list of affiliates for a store, with optional filtering by status and pagination
+    support.
+
+    **Usage:** Analyze and manage affiliates for promotional strategies.
+
+    Args:
+        status (str | Unset):
+        limit (int | Unset):  Default: 10.
+        page (int | Unset):  Default: 1.
+
+    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[AffiliatesListResponse | Any]
+    """
+
+    kwargs = _get_kwargs(
+        status=status,
+        limit=limit,
+        page=page,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient | Client,
+    status: str | Unset = UNSET,
+    limit: int | Unset = 10,
+    page: int | Unset = 1,
+) -> AffiliatesListResponse | Any | None:
+    """List affiliates
+
+     Retrieves a list of affiliates for a store, with optional filtering by status and pagination
+    support.
+
+    **Usage:** Analyze and manage affiliates for promotional strategies.
+
+    Args:
+        status (str | Unset):
+        limit (int | Unset):  Default: 10.
+        page (int | Unset):  Default: 1.
+
+    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:
+        AffiliatesListResponse | Any
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            status=status,
+            limit=limit,
+            page=page,
+        )
+    ).parsed

blink_api_client/api/affiliates/get_affiliates_id.py

@@ -0,0 +1,187 @@
+from http import HTTPStatus
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.affiliate_detail_response import AffiliateDetailResponse
+from ...types import Response
+
+
+def _get_kwargs(
+    id: str,
+) -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/affiliates/{id}".format(
+            id=quote(str(id), safe=""),
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> AffiliateDetailResponse | Any | None:
+    if response.status_code == 200:
+        response_200 = AffiliateDetailResponse.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 401:
+        response_401 = cast(Any, None)
+        return response_401
+
+    if response.status_code == 404:
+        response_404 = cast(Any, None)
+        return response_404
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[AffiliateDetailResponse | Any]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    id: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[AffiliateDetailResponse | Any]:
+    """Retrieve affiliate details
+
+     Retrieves details of a specific affiliate membership using its ID. It includes affiliate profile
+    information and conversion statistics.
+
+    **Usage:** Use this to get detailed insights into an individual affiliate's performance, including
+    total revenue and pending commissions.
+
+    Args:
+        id (str):
+
+    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[AffiliateDetailResponse | Any]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    id: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> AffiliateDetailResponse | Any | None:
+    """Retrieve affiliate details
+
+     Retrieves details of a specific affiliate membership using its ID. It includes affiliate profile
+    information and conversion statistics.
+
+    **Usage:** Use this to get detailed insights into an individual affiliate's performance, including
+    total revenue and pending commissions.
+
+    Args:
+        id (str):
+
+    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:
+        AffiliateDetailResponse | Any
+    """
+
+    return sync_detailed(
+        id=id,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    id: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[AffiliateDetailResponse | Any]:
+    """Retrieve affiliate details
+
+     Retrieves details of a specific affiliate membership using its ID. It includes affiliate profile
+    information and conversion statistics.
+
+    **Usage:** Use this to get detailed insights into an individual affiliate's performance, including
+    total revenue and pending commissions.
+
+    Args:
+        id (str):
+
+    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[AffiliateDetailResponse | Any]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    id: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> AffiliateDetailResponse | Any | None:
+    """Retrieve affiliate details
+
+     Retrieves details of a specific affiliate membership using its ID. It includes affiliate profile
+    information and conversion statistics.
+
+    **Usage:** Use this to get detailed insights into an individual affiliate's performance, including
+    total revenue and pending commissions.
+
+    Args:
+        id (str):
+
+    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:
+        AffiliateDetailResponse | Any
+    """
+
+    return (
+        await asyncio_detailed(
+            id=id,
+            client=client,
+        )
+    ).parsed

blink_api_client/api/affiliates/get_affiliates_id_conversions.py

@@ -0,0 +1,223 @@
+from http import HTTPStatus
+from typing import Any, cast
+from urllib.parse import quote
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.affiliate_conversions import AffiliateConversions
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    id: str,
+    *,
+    limit: int | Unset = 10,
+    page: int | Unset = 1,
+) -> dict[str, Any]:
+
+    params: dict[str, Any] = {}
+
+    params["limit"] = limit
+
+    params["page"] = page
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/affiliates/{id}/conversions".format(
+            id=quote(str(id), safe=""),
+        ),
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> AffiliateConversions | Any | None:
+    if response.status_code == 200:
+        response_200 = AffiliateConversions.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 401:
+        response_401 = cast(Any, None)
+        return response_401
+
+    if response.status_code == 404:
+        response_404 = cast(Any, None)
+        return response_404
+
+    if client.raise_on_unexpected_status:
+        raise errors.UnexpectedStatus(response.status_code, response.content)
+    else:
+        return None
+
+
+def _build_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Response[AffiliateConversions | Any]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    id: str,
+    *,
+    client: AuthenticatedClient | Client,
+    limit: int | Unset = 10,
+    page: int | Unset = 1,
+) -> Response[AffiliateConversions | Any]:
+    """Get affiliate conversions
+
+     Retrieves a list of orders that are attributed to a specific affiliate based on their membership ID.
+    Provides detailed order information, including the status, amount, and commission.
+
+    **Usage:** Allows affiliates to track their performance and commissions by viewing the orders they
+    have influenced.
+
+    Args:
+        id (str):
+        limit (int | Unset):  Default: 10.
+        page (int | Unset):  Default: 1.
+
+    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[AffiliateConversions | Any]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+        limit=limit,
+        page=page,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    id: str,
+    *,
+    client: AuthenticatedClient | Client,
+    limit: int | Unset = 10,
+    page: int | Unset = 1,
+) -> AffiliateConversions | Any | None:
+    """Get affiliate conversions
+
+     Retrieves a list of orders that are attributed to a specific affiliate based on their membership ID.
+    Provides detailed order information, including the status, amount, and commission.
+
+    **Usage:** Allows affiliates to track their performance and commissions by viewing the orders they
+    have influenced.
+
+    Args:
+        id (str):
+        limit (int | Unset):  Default: 10.
+        page (int | Unset):  Default: 1.
+
+    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:
+        AffiliateConversions | Any
+    """
+
+    return sync_detailed(
+        id=id,
+        client=client,
+        limit=limit,
+        page=page,
+    ).parsed
+
+
+async def asyncio_detailed(
+    id: str,
+    *,
+    client: AuthenticatedClient | Client,
+    limit: int | Unset = 10,
+    page: int | Unset = 1,
+) -> Response[AffiliateConversions | Any]:
+    """Get affiliate conversions
+
+     Retrieves a list of orders that are attributed to a specific affiliate based on their membership ID.
+    Provides detailed order information, including the status, amount, and commission.
+
+    **Usage:** Allows affiliates to track their performance and commissions by viewing the orders they
+    have influenced.
+
+    Args:
+        id (str):
+        limit (int | Unset):  Default: 10.
+        page (int | Unset):  Default: 1.
+
+    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[AffiliateConversions | Any]
+    """
+
+    kwargs = _get_kwargs(
+        id=id,
+        limit=limit,
+        page=page,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    id: str,
+    *,
+    client: AuthenticatedClient | Client,
+    limit: int | Unset = 10,
+    page: int | Unset = 1,
+) -> AffiliateConversions | Any | None:
+    """Get affiliate conversions
+
+     Retrieves a list of orders that are attributed to a specific affiliate based on their membership ID.
+    Provides detailed order information, including the status, amount, and commission.
+
+    **Usage:** Allows affiliates to track their performance and commissions by viewing the orders they
+    have influenced.
+
+    Args:
+        id (str):
+        limit (int | Unset):  Default: 10.
+        page (int | Unset):  Default: 1.
+
+    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:
+        AffiliateConversions | Any
+    """
+
+    return (
+        await asyncio_detailed(
+            id=id,
+            client=client,
+            limit=limit,
+            page=page,
+        )
+    ).parsed