invowerk 1.0.0__tar.gz

invowerk-1.0.0/PKG-INFO

@@ -0,0 +1,49 @@
+Metadata-Version: 2.3
+Name: invowerk
+Version: 1.0.0
+Summary: A client library for accessing invowerk
+Requires-Dist: httpx>=0.23.1,<0.29.0
+Requires-Dist: attrs>=22.2.0
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# invowerk — Python SDK
+
+Python client for the invowerk API: validate XRechnung, ZUGFeRD, Factur-X and Peppol BIS e-invoices from your code or CI.
+
+```sh
+pip install invowerk
+```
+
+[Get an API key](https://invowerk.dev/go/pypi-sdk?to=/app/api-keys) and pass it to the client:
+
+```python
+import os
+
+from invowerk import AuthenticatedClient
+from invowerk.api.account import get_me
+
+client = AuthenticatedClient(
+    base_url="https://api.invowerk.dev",
+    token=os.environ["INVOWERK_API_KEY"],
+    auth_header_name="X-API-Key",
+    prefix="",
+)
+print(get_me.sync(client=client))
+```
+
+Every operation is a module with `sync`, `sync_detailed`, `asyncio` and `asyncio_detailed`; file fields take a `invowerk.types.File(payload=..., file_name=..., mime_type=...)`.
+
+## Operations
+
+| Operation | Module | What it does |
+|---|---|---|
+| `GET /v1/me` | `invowerk.api.account.get_me` | Your plan, remaining requests, and remaining credits |
+| `POST /v1/parse` | `invowerk.api.transform.parse_invoice` | Read an e-invoice into JSON |
+| `POST /v1/convert` | `invowerk.api.transform.convert_invoice` | Convert an e-invoice between UBL and CII |
+| `POST /v1/generate` | `invowerk.api.generation.generate_invoice` | Create an e-invoice from JSON |
+| `GET /v1/explain` | `invowerk.api.rules.explain_codes` | Explain an error code |
+| `POST /v1/render` | `invowerk.api.rendering.render_invoice` | Render an e-invoice as HTML |
+| `POST /v1/validate` | `invowerk.api.validation.validate_invoice` | Check an e-invoice |
+
+Generated with openapi-python-client from [`openapi.sdk.json`](../openapi.sdk.json). API reference: https://invowerk.dev/docs · Support: https://invowerk.dev/support

invowerk-1.0.0/README.md

@@ -0,0 +1,40 @@
+# invowerk — Python SDK
+
+Python client for the invowerk API: validate XRechnung, ZUGFeRD, Factur-X and Peppol BIS e-invoices from your code or CI.
+
+```sh
+pip install invowerk
+```
+
+[Get an API key](https://invowerk.dev/go/pypi-sdk?to=/app/api-keys) and pass it to the client:
+
+```python
+import os
+
+from invowerk import AuthenticatedClient
+from invowerk.api.account import get_me
+
+client = AuthenticatedClient(
+    base_url="https://api.invowerk.dev",
+    token=os.environ["INVOWERK_API_KEY"],
+    auth_header_name="X-API-Key",
+    prefix="",
+)
+print(get_me.sync(client=client))
+```
+
+Every operation is a module with `sync`, `sync_detailed`, `asyncio` and `asyncio_detailed`; file fields take a `invowerk.types.File(payload=..., file_name=..., mime_type=...)`.
+
+## Operations
+
+| Operation | Module | What it does |
+|---|---|---|
+| `GET /v1/me` | `invowerk.api.account.get_me` | Your plan, remaining requests, and remaining credits |
+| `POST /v1/parse` | `invowerk.api.transform.parse_invoice` | Read an e-invoice into JSON |
+| `POST /v1/convert` | `invowerk.api.transform.convert_invoice` | Convert an e-invoice between UBL and CII |
+| `POST /v1/generate` | `invowerk.api.generation.generate_invoice` | Create an e-invoice from JSON |
+| `GET /v1/explain` | `invowerk.api.rules.explain_codes` | Explain an error code |
+| `POST /v1/render` | `invowerk.api.rendering.render_invoice` | Render an e-invoice as HTML |
+| `POST /v1/validate` | `invowerk.api.validation.validate_invoice` | Check an e-invoice |
+
+Generated with openapi-python-client from [`openapi.sdk.json`](../openapi.sdk.json). API reference: https://invowerk.dev/docs · Support: https://invowerk.dev/support

invowerk-1.0.0/invowerk/__init__.py

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

invowerk-1.0.0/invowerk/api/__init__.py

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

invowerk-1.0.0/invowerk/api/account/__init__.py

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

invowerk-1.0.0/invowerk/api/account/get_me.py

@@ -0,0 +1,176 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.me_response import MeResponse
+from ...types import Response
+
+
+def _get_kwargs() -> dict[str, Any]:
+
+    _kwargs: dict[str, Any] = {
+        "method": "get",
+        "url": "/v1/me",
+    }
+
+    return _kwargs
+
+
+def _parse_response(*, client: AuthenticatedClient | Client, response: httpx.Response) -> MeResponse | None:
+    if response.status_code == 200:
+        response_200 = MeResponse.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[MeResponse]:
+    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,
+) -> Response[MeResponse]:
+    """Your plan, remaining requests, and remaining credits
+
+     Check where you stand before a call fails.
+
+    Returns the plan this request runs on and whether your key was recognized.
+    Without an `X-API-Key`, the call runs anonymously at the rate limit for
+    calls without a key. It also returns the requests left in the current window
+    and the features your plan includes. On plans priced in credits, it returns
+    the credits left in the current billing period.
+
+    This call does not count against your rate limit, so the numbers it reports
+    are the numbers you have.
+
+    **Credits:** free. This endpoint is not metered.
+
+    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[MeResponse]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+) -> MeResponse | None:
+    """Your plan, remaining requests, and remaining credits
+
+     Check where you stand before a call fails.
+
+    Returns the plan this request runs on and whether your key was recognized.
+    Without an `X-API-Key`, the call runs anonymously at the rate limit for
+    calls without a key. It also returns the requests left in the current window
+    and the features your plan includes. On plans priced in credits, it returns
+    the credits left in the current billing period.
+
+    This call does not count against your rate limit, so the numbers it reports
+    are the numbers you have.
+
+    **Credits:** free. This endpoint is not metered.
+
+    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:
+        MeResponse
+    """
+
+    return sync_detailed(
+        client=client,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+) -> Response[MeResponse]:
+    """Your plan, remaining requests, and remaining credits
+
+     Check where you stand before a call fails.
+
+    Returns the plan this request runs on and whether your key was recognized.
+    Without an `X-API-Key`, the call runs anonymously at the rate limit for
+    calls without a key. It also returns the requests left in the current window
+    and the features your plan includes. On plans priced in credits, it returns
+    the credits left in the current billing period.
+
+    This call does not count against your rate limit, so the numbers it reports
+    are the numbers you have.
+
+    **Credits:** free. This endpoint is not metered.
+
+    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[MeResponse]
+    """
+
+    kwargs = _get_kwargs()
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient,
+) -> MeResponse | None:
+    """Your plan, remaining requests, and remaining credits
+
+     Check where you stand before a call fails.
+
+    Returns the plan this request runs on and whether your key was recognized.
+    Without an `X-API-Key`, the call runs anonymously at the rate limit for
+    calls without a key. It also returns the requests left in the current window
+    and the features your plan includes. On plans priced in credits, it returns
+    the credits left in the current billing period.
+
+    This call does not count against your rate limit, so the numbers it reports
+    are the numbers you have.
+
+    **Credits:** free. This endpoint is not metered.
+
+    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:
+        MeResponse
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+        )
+    ).parsed

invowerk-1.0.0/invowerk/api/generation/__init__.py

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

invowerk-1.0.0/invowerk/api/generation/generate_invoice.py

@@ -0,0 +1,284 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.generate_request import GenerateRequest
+from ...models.generate_response import GenerateResponse
+from ...models.problem import Problem
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    *,
+    body: GenerateRequest,
+    format_: None | str | Unset = "json",
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+
+    params: dict[str, Any] = {}
+
+    json_format_: None | str | Unset
+    if isinstance(format_, Unset):
+        json_format_ = UNSET
+    else:
+        json_format_ = format_
+    params["format"] = json_format_
+
+    params = {k: v for k, v in params.items() if v is not UNSET and v is not None}
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/v1/generate",
+        "params": params,
+    }
+
+    _kwargs["json"] = body.to_dict()
+
+    headers["Content-Type"] = "application/json"
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> GenerateResponse | Problem | None:
+    if response.status_code == 200:
+        response_200 = GenerateResponse.from_dict(response.json())
+
+        return response_200
+
+    if response.status_code == 422:
+        response_422 = Problem.from_dict(response.json())
+
+        return response_422
+
+    if response.status_code == 500:
+        response_500 = Problem.from_dict(response.json())
+
+        return response_500
+
+    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[GenerateResponse | Problem]:
+    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,
+    body: GenerateRequest,
+    format_: None | str | Unset = "json",
+) -> Response[GenerateResponse | Problem]:
+    """Create an e-invoice from JSON
+
+     Create an EN 16931 e-invoice from JSON.
+
+    The JSON body is keyed on EN 16931 Business Terms (BT-*). `syntax` selects UBL
+    (default) or CII. `flavor` selects plain EN 16931 (default) or XRechnung, which
+    requires `buyer_reference` (BT-10, the Leitweg-ID). invowerk writes your
+    amounts as given. It does not compute or correct them. Before answering,
+    invowerk checks the generated XML and never returns an invalid document. The
+    answer is `application/xml`; `?format=json` returns
+    `{xml, syntax, flavor, self_validation}`. Errors: 422 for invalid input, with
+    details per field; 500 when the generated XML fails the check (the credits are
+    refunded); 429 when every slot is busy (callers without an API key share
+    one); 504 when it took longer than 20 s. Costs 5 credits.
+
+    **Credits:** 5 per call.
+
+    Args:
+        format_ (None | str | Unset): 'json' returns {xml, syntax, flavor, self_validation};
+            omitted returns raw application/xml. Default: 'json'.
+        body (GenerateRequest): The request body of POST /v1/generate: an EN 16931 invoice, keyed
+            on
+            Business Terms (BT-*).
+
+            All amounts are your own figures. invowerk writes them into the XML and
+            checks the result against EN 16931 (and XRechnung, if selected). It does not
+            compute or correct them.
+
+    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[GenerateResponse | Problem]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+        format_=format_,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient,
+    body: GenerateRequest,
+    format_: None | str | Unset = "json",
+) -> GenerateResponse | Problem | None:
+    """Create an e-invoice from JSON
+
+     Create an EN 16931 e-invoice from JSON.
+
+    The JSON body is keyed on EN 16931 Business Terms (BT-*). `syntax` selects UBL
+    (default) or CII. `flavor` selects plain EN 16931 (default) or XRechnung, which
+    requires `buyer_reference` (BT-10, the Leitweg-ID). invowerk writes your
+    amounts as given. It does not compute or correct them. Before answering,
+    invowerk checks the generated XML and never returns an invalid document. The
+    answer is `application/xml`; `?format=json` returns
+    `{xml, syntax, flavor, self_validation}`. Errors: 422 for invalid input, with
+    details per field; 500 when the generated XML fails the check (the credits are
+    refunded); 429 when every slot is busy (callers without an API key share
+    one); 504 when it took longer than 20 s. Costs 5 credits.
+
+    **Credits:** 5 per call.
+
+    Args:
+        format_ (None | str | Unset): 'json' returns {xml, syntax, flavor, self_validation};
+            omitted returns raw application/xml. Default: 'json'.
+        body (GenerateRequest): The request body of POST /v1/generate: an EN 16931 invoice, keyed
+            on
+            Business Terms (BT-*).
+
+            All amounts are your own figures. invowerk writes them into the XML and
+            checks the result against EN 16931 (and XRechnung, if selected). It does not
+            compute or correct them.
+
+    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:
+        GenerateResponse | Problem
+    """
+
+    return sync_detailed(
+        client=client,
+        body=body,
+        format_=format_,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient,
+    body: GenerateRequest,
+    format_: None | str | Unset = "json",
+) -> Response[GenerateResponse | Problem]:
+    """Create an e-invoice from JSON
+
+     Create an EN 16931 e-invoice from JSON.
+
+    The JSON body is keyed on EN 16931 Business Terms (BT-*). `syntax` selects UBL
+    (default) or CII. `flavor` selects plain EN 16931 (default) or XRechnung, which
+    requires `buyer_reference` (BT-10, the Leitweg-ID). invowerk writes your
+    amounts as given. It does not compute or correct them. Before answering,
+    invowerk checks the generated XML and never returns an invalid document. The
+    answer is `application/xml`; `?format=json` returns
+    `{xml, syntax, flavor, self_validation}`. Errors: 422 for invalid input, with
+    details per field; 500 when the generated XML fails the check (the credits are
+    refunded); 429 when every slot is busy (callers without an API key share
+    one); 504 when it took longer than 20 s. Costs 5 credits.
+
+    **Credits:** 5 per call.
+
+    Args:
+        format_ (None | str | Unset): 'json' returns {xml, syntax, flavor, self_validation};
+            omitted returns raw application/xml. Default: 'json'.
+        body (GenerateRequest): The request body of POST /v1/generate: an EN 16931 invoice, keyed
+            on
+            Business Terms (BT-*).
+
+            All amounts are your own figures. invowerk writes them into the XML and
+            checks the result against EN 16931 (and XRechnung, if selected). It does not
+            compute or correct them.
+
+    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[GenerateResponse | Problem]
+    """
+
+    kwargs = _get_kwargs(
+        body=body,
+        format_=format_,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient,
+    body: GenerateRequest,
+    format_: None | str | Unset = "json",
+) -> GenerateResponse | Problem | None:
+    """Create an e-invoice from JSON
+
+     Create an EN 16931 e-invoice from JSON.
+
+    The JSON body is keyed on EN 16931 Business Terms (BT-*). `syntax` selects UBL
+    (default) or CII. `flavor` selects plain EN 16931 (default) or XRechnung, which
+    requires `buyer_reference` (BT-10, the Leitweg-ID). invowerk writes your
+    amounts as given. It does not compute or correct them. Before answering,
+    invowerk checks the generated XML and never returns an invalid document. The
+    answer is `application/xml`; `?format=json` returns
+    `{xml, syntax, flavor, self_validation}`. Errors: 422 for invalid input, with
+    details per field; 500 when the generated XML fails the check (the credits are
+    refunded); 429 when every slot is busy (callers without an API key share
+    one); 504 when it took longer than 20 s. Costs 5 credits.
+
+    **Credits:** 5 per call.
+
+    Args:
+        format_ (None | str | Unset): 'json' returns {xml, syntax, flavor, self_validation};
+            omitted returns raw application/xml. Default: 'json'.
+        body (GenerateRequest): The request body of POST /v1/generate: an EN 16931 invoice, keyed
+            on
+            Business Terms (BT-*).
+
+            All amounts are your own figures. invowerk writes them into the XML and
+            checks the result against EN 16931 (and XRechnung, if selected). It does not
+            compute or correct them.
+
+    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:
+        GenerateResponse | Problem
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            body=body,
+            format_=format_,
+        )
+    ).parsed

invowerk-1.0.0/invowerk/api/rendering/__init__.py

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