daichodo 0.1.0__tar.gz

daichodo-0.1.0/PKG-INFO

@@ -0,0 +1,73 @@
+Metadata-Version: 2.1
+Name: daichodo
+Version: 0.1.0
+Summary: A client library for accessing Daichodo
+Requires-Python: >=3.11
+Requires-Dist: httpx<0.29.0,>=0.23.1
+Requires-Dist: attrs>=22.2.0
+Description-Content-Type: text/markdown
+
+# daichodo
+
+Daichodo API の Python クライアント。適格請求書発行事業者（インボイス）登録番号と
+法人番号を照会します。
+
+Python client for the [Daichodo](https://daichodo.com) API — Japanese qualified
+invoice issuer (適格請求書発行事業者) and corporate number (法人番号) lookup,
+validation, and point-in-time validity.
+
+> **⚠️ API はまだ一般公開されていません。**
+> このパッケージは API の公開前に名前を確保するために公開されています。現時点では
+> 呼び出しても接続できません。公開時期は [daichodo.com](https://daichodo.com) を
+> ご確認ください。
+>
+> **⚠️ The API is not publicly available yet.**
+> This package is published ahead of the service to reserve the name. Calls will
+> not connect until the API launches — see
+> [daichodo.com](https://daichodo.com) for availability.
+>
+> **APIキーが不要な検証だけであれば
+> [`daichodo-validate`](https://pypi.org/project/daichodo-validate/)
+> が今すぐ利用できます。**
+> If you only need format and check-digit validation,
+> [`daichodo-validate`](https://pypi.org/project/daichodo-validate/) works today
+> with no API key.
+
+```bash
+pip install daichodo
+```
+
+```python
+from daichodo import AuthenticatedClient
+from daichodo.api.registry import get_invoice_issuer
+
+client = AuthenticatedClient(
+    base_url="https://api.daichodo.com",
+    token="dc_live_...",
+)
+
+issuer = get_invoice_issuer.sync(client=client, registration_number="T1010001153225")
+```
+
+## `name` が None でもエラーではありません / `name` is None for sole traders
+
+国税庁は個人事業主の氏名・住所を公表データから除外しています。個人事業主のレコードは
+日付を保持したまま**氏名が None** で返ります。`name is None` を「該当なし」と解釈する
+のが最も多い誤りで、登録簿の約半数を無言で切り捨てることになります。
+
+The NTA strips identity fields for individuals at source, so a sole trader
+returns their dates with **no name**. Treating `name is None` as "not found" is
+the most common way to get this wrong, and it silently discards about half the
+register.
+
+## 生成コードです / This code is generated
+
+API の OpenAPI スキーマから自動生成され、リリースごとに上書きされます。
+プルリクエストは受け付けられません。不具合は
+[Issue](https://github.com/daichodo/daichodo-python/issues) でご報告ください。
+
+Generated from the API's OpenAPI schema and overwritten on every release.
+
+## ライセンス / Licence
+
+MIT.

daichodo-0.1.0/README.md

@@ -0,0 +1,64 @@
+# daichodo
+
+Daichodo API の Python クライアント。適格請求書発行事業者（インボイス）登録番号と
+法人番号を照会します。
+
+Python client for the [Daichodo](https://daichodo.com) API — Japanese qualified
+invoice issuer (適格請求書発行事業者) and corporate number (法人番号) lookup,
+validation, and point-in-time validity.
+
+> **⚠️ API はまだ一般公開されていません。**
+> このパッケージは API の公開前に名前を確保するために公開されています。現時点では
+> 呼び出しても接続できません。公開時期は [daichodo.com](https://daichodo.com) を
+> ご確認ください。
+>
+> **⚠️ The API is not publicly available yet.**
+> This package is published ahead of the service to reserve the name. Calls will
+> not connect until the API launches — see
+> [daichodo.com](https://daichodo.com) for availability.
+>
+> **APIキーが不要な検証だけであれば
+> [`daichodo-validate`](https://pypi.org/project/daichodo-validate/)
+> が今すぐ利用できます。**
+> If you only need format and check-digit validation,
+> [`daichodo-validate`](https://pypi.org/project/daichodo-validate/) works today
+> with no API key.
+
+```bash
+pip install daichodo
+```
+
+```python
+from daichodo import AuthenticatedClient
+from daichodo.api.registry import get_invoice_issuer
+
+client = AuthenticatedClient(
+    base_url="https://api.daichodo.com",
+    token="dc_live_...",
+)
+
+issuer = get_invoice_issuer.sync(client=client, registration_number="T1010001153225")
+```
+
+## `name` が None でもエラーではありません / `name` is None for sole traders
+
+国税庁は個人事業主の氏名・住所を公表データから除外しています。個人事業主のレコードは
+日付を保持したまま**氏名が None** で返ります。`name is None` を「該当なし」と解釈する
+のが最も多い誤りで、登録簿の約半数を無言で切り捨てることになります。
+
+The NTA strips identity fields for individuals at source, so a sole trader
+returns their dates with **no name**. Treating `name is None` as "not found" is
+the most common way to get this wrong, and it silently discards about half the
+register.
+
+## 生成コードです / This code is generated
+
+API の OpenAPI スキーマから自動生成され、リリースごとに上書きされます。
+プルリクエストは受け付けられません。不具合は
+[Issue](https://github.com/daichodo/daichodo-python/issues) でご報告ください。
+
+Generated from the API's OpenAPI schema and overwritten on every release.
+
+## ライセンス / Licence
+
+MIT.

daichodo-0.1.0/daichodo/__init__.py

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

daichodo-0.1.0/daichodo/api/__init__.py

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

daichodo-0.1.0/daichodo/api/meta/__init__.py

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

daichodo-0.1.0/daichodo/api/meta/health.py

@@ -0,0 +1,124 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.health import Health
+from ...types import Response
+
+
+def _get_kwargs() -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/v1/health",
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> Health | None:
+    if response.status_code == 200:
+        response_200 = Health.from_dict(response.json())
+
+        return response_200
+
+    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[Health]:
+    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,
+) -> Response[Health]:
+    """Liveness check
+
+    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[Health]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient | Client,
+) -> Health | None:
+    """Liveness check
+
+    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:
+        Health
+    """
+
+    return sync_detailed(
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[Health]:
+    """Liveness check
+
+    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[Health]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient | Client,
+) -> Health | None:
+    """Liveness check
+
+    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:
+        Health
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+        )
+    ).parsed

daichodo-0.1.0/daichodo/api/registry/__init__.py

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

daichodo-0.1.0/daichodo/api/registry/get_corporation.py

@@ -0,0 +1,169 @@
+from http import HTTPStatus
+from typing import Any
+from urllib.parse import quote
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.corporation import Corporation
+from ...models.http_validation_error import HTTPValidationError
+from ...types import Response
+
+
+def _get_kwargs(
+    corporate_number: str,
+) -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/v1/corporations/{corporate_number}".format(
+            corporate_number=quote(str(corporate_number), safe=""),
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> Corporation | HTTPValidationError | None:
+    if response.status_code == 200:
+        response_200 = Corporation.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 422:
+        response_422 = HTTPValidationError.from_dict(response.json())
+
+        return response_422
+
+    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[Corporation | HTTPValidationError]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    corporate_number: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[Corporation | HTTPValidationError]:
+    """Look up a corporate number
+
+     Current published information for a 法人番号. Counts against your quota.
+
+    Args:
+        corporate_number (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[Corporation | HTTPValidationError]
+    """
+
+    kwargs = _get_kwargs(
+        corporate_number=corporate_number,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    corporate_number: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Corporation | HTTPValidationError | None:
+    """Look up a corporate number
+
+     Current published information for a 法人番号. Counts against your quota.
+
+    Args:
+        corporate_number (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:
+        Corporation | HTTPValidationError
+    """
+
+    return sync_detailed(
+        corporate_number=corporate_number,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    corporate_number: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[Corporation | HTTPValidationError]:
+    """Look up a corporate number
+
+     Current published information for a 法人番号. Counts against your quota.
+
+    Args:
+        corporate_number (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[Corporation | HTTPValidationError]
+    """
+
+    kwargs = _get_kwargs(
+        corporate_number=corporate_number,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    corporate_number: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Corporation | HTTPValidationError | None:
+    """Look up a corporate number
+
+     Current published information for a 法人番号. Counts against your quota.
+
+    Args:
+        corporate_number (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:
+        Corporation | HTTPValidationError
+    """
+
+    return (
+        await asyncio_detailed(
+            corporate_number=corporate_number,
+            client=client,
+        )
+    ).parsed

daichodo-0.1.0/daichodo/api/registry/get_invoice_issuer.py

@@ -0,0 +1,177 @@
+from http import HTTPStatus
+from typing import Any
+from urllib.parse import quote
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.http_validation_error import HTTPValidationError
+from ...models.invoice_issuer import InvoiceIssuer
+from ...types import Response
+
+
+def _get_kwargs(
+    registration_number: str,
+) -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/v1/invoice-issuers/{registration_number}".format(
+            registration_number=quote(str(registration_number), safe=""),
+        ),
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> HTTPValidationError | InvoiceIssuer | None:
+    if response.status_code == 200:
+        response_200 = InvoiceIssuer.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 422:
+        response_422 = HTTPValidationError.from_dict(response.json())
+
+        return response_422
+
+    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[HTTPValidationError | InvoiceIssuer]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    registration_number: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[HTTPValidationError | InvoiceIssuer]:
+    """Look up a qualified invoice issuer
+
+     Current published information for a 登録番号. Counts against your monthly quota.
+
+    Sole traders return dates with a null `name` - that is a valid record, not a miss.
+
+    Args:
+        registration_number (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[HTTPValidationError | InvoiceIssuer]
+    """
+
+    kwargs = _get_kwargs(
+        registration_number=registration_number,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    registration_number: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> HTTPValidationError | InvoiceIssuer | None:
+    """Look up a qualified invoice issuer
+
+     Current published information for a 登録番号. Counts against your monthly quota.
+
+    Sole traders return dates with a null `name` - that is a valid record, not a miss.
+
+    Args:
+        registration_number (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:
+        HTTPValidationError | InvoiceIssuer
+    """
+
+    return sync_detailed(
+        registration_number=registration_number,
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    registration_number: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> Response[HTTPValidationError | InvoiceIssuer]:
+    """Look up a qualified invoice issuer
+
+     Current published information for a 登録番号. Counts against your monthly quota.
+
+    Sole traders return dates with a null `name` - that is a valid record, not a miss.
+
+    Args:
+        registration_number (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[HTTPValidationError | InvoiceIssuer]
+    """
+
+    kwargs = _get_kwargs(
+        registration_number=registration_number,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    registration_number: str,
+    *,
+    client: AuthenticatedClient | Client,
+) -> HTTPValidationError | InvoiceIssuer | None:
+    """Look up a qualified invoice issuer
+
+     Current published information for a 登録番号. Counts against your monthly quota.
+
+    Sole traders return dates with a null `name` - that is a valid record, not a miss.
+
+    Args:
+        registration_number (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:
+        HTTPValidationError | InvoiceIssuer
+    """
+
+    return (
+        await asyncio_detailed(
+            registration_number=registration_number,
+            client=client,
+        )
+    ).parsed