convexity-api-client 0.21.0.dev372__tar.gz → 0.21.0.dev374__tar.gz

convexity_api_client-0.21.0.dev374/PKG-INFO

@@ -0,0 +1,131 @@
+Metadata-Version: 2.3
+Name: convexity_api_client
+Version: 0.21.0.dev374
+Summary: A client library for accessing Convexity API
+Requires-Dist: httpx>=0.23.1,<0.29.0
+Requires-Dist: attrs>=22.2.0
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+
+# convexity_api_client
+A client library for accessing Convexity API
+
+## Usage
+First, create a client:
+
+```python
+from convexity_api_client import Client
+
+client = Client(base_url="https://api.example.com")
+```
+
+If the endpoints you're going to hit require authentication, use `AuthenticatedClient` instead:
+
+```python
+from convexity_api_client import AuthenticatedClient
+
+client = AuthenticatedClient(base_url="https://api.example.com", token="SuperSecretToken")
+```
+
+Now call your endpoint and use your models:
+
+```python
+from convexity_api_client.models import MyDataModel
+from convexity_api_client.api.my_tag import get_my_data_model
+from convexity_api_client.types import Response
+
+with client as client:
+    my_data: MyDataModel = get_my_data_model.sync(client=client)
+    # or if you need more info (e.g. status_code)
+    response: Response[MyDataModel] = get_my_data_model.sync_detailed(client=client)
+```
+
+Or do the same thing with an async version:
+
+```python
+from convexity_api_client.models import MyDataModel
+from convexity_api_client.api.my_tag import get_my_data_model
+from convexity_api_client.types import Response
+
+async with client as client:
+    my_data: MyDataModel = await get_my_data_model.asyncio(client=client)
+    response: Response[MyDataModel] = await get_my_data_model.asyncio_detailed(client=client)
+```
+
+By default, when you're calling an HTTPS API it will attempt to verify that SSL is working correctly. Using certificate verification is highly recommended most of the time, but sometimes you may need to authenticate to a server (especially an internal server) using a custom certificate bundle.
+
+```python
+client = AuthenticatedClient(
+    base_url="https://internal_api.example.com",
+    token="SuperSecretToken",
+    verify_ssl="/path/to/certificate_bundle.pem",
+)
+```
+
+You can also disable certificate validation altogether, but beware that **this is a security risk**.
+
+```python
+client = AuthenticatedClient(base_url="https://internal_api.example.com", token="SuperSecretToken", verify_ssl=False)
+```
+
+Things to know:
+1. Every path/method combo becomes a Python module with four functions:
+    1. `sync`: Blocking request that returns parsed data (if successful) or `None`
+    1. `sync_detailed`: Blocking request that always returns a `Request`, optionally with `parsed` set if the request was successful.
+    1. `asyncio`: Like `sync` but async instead of blocking
+    1. `asyncio_detailed`: Like `sync_detailed` but async instead of blocking
+
+1. All path/query params, and bodies become method arguments.
+1. If your endpoint had any tags on it, the first tag will be used as a module name for the function (my_tag above)
+1. Any endpoint which did not have a tag will be in `convexity_api_client.api.default`
+
+## Advanced customizations
+
+There are more settings on the generated `Client` class which let you control more runtime behavior, check out the docstring on that class for more info. You can also customize the underlying `httpx.Client` or `httpx.AsyncClient` (depending on your use-case):
+
+```python
+from convexity_api_client import Client
+
+
+def log_request(request):
+    print(f"Request event hook: {request.method} {request.url} - Waiting for response")
+
+
+def log_response(response):
+    request = response.request
+    print(f"Response event hook: {request.method} {request.url} - Status {response.status_code}")
+
+
+client = Client(
+    base_url="https://api.example.com",
+    httpx_args={"event_hooks": {"request": [log_request], "response": [log_response]}},
+)
+
+# Or get the underlying httpx client to modify directly with client.get_httpx_client() or client.get_async_httpx_client()
+```
+
+You can even set the httpx client directly, but beware that this will override any existing settings (e.g., base_url):
+
+```python
+import httpx
+from convexity_api_client import Client
+
+client = Client(
+    base_url="https://api.example.com",
+)
+# Note that base_url needs to be re-set, as would any shared cookies, headers, etc.
+client.set_httpx_client(httpx.Client(base_url="https://api.example.com", proxies="http://localhost:8030"))
+```
+
+## Building / publishing this package
+This project uses [uv](https://github.com/astral-sh/uv) to manage dependencies and packaging. Here are the basics:
+1. Update the metadata in `pyproject.toml` (e.g. authors, version).
+2. If you're using a private repository: https://docs.astral.sh/uv/guides/integration/alternative-indexes/
+3. Build a distribution with `uv build`, builds `sdist` and `wheel` by default.
+1. Publish the client with `uv publish`, see documentation for publishing to private indexes.
+
+If you want to install this client into another project without publishing it (e.g. for development) then:
+1. If that project **is using uv**, you can simply do `uv add <path-to-this-client>` from that project
+1. If that project is not using uv:
+    1. Build a wheel with `uv build --wheel`.
+    1. Install that wheel from the other project `pip install <path-to-wheel>`.

convexity_api_client-0.21.0.dev374/convexity_api_client/api/v1/analytics_get_kpi_timeseries.py

@@ -0,0 +1,340 @@
+import datetime
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.date_grain import DateGrain
+from ...models.http_validation_error import HTTPValidationError
+from ...models.kpi_snapshot_dimension import KpiSnapshotDimension
+from ...models.kpi_timeseries_response import KpiTimeseriesResponse
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    *,
+    dimension: KpiSnapshotDimension,
+    kpi_name: str,
+    period_start: datetime.date,
+    period_end: datetime.date,
+    date_grain: DateGrain,
+    dimension_id: None | str | Unset = UNSET,
+    window_days: int | None | Unset = UNSET,
+    project_id: str,
+) -> dict[str, Any]:
+
+    params: dict[str, Any] = {}
+
+    json_dimension = dimension.value
+    params["dimension"] = json_dimension
+
+    params["kpi_name"] = kpi_name
+
+    json_period_start = period_start.isoformat()
+    params["period_start"] = json_period_start
+
+    json_period_end = period_end.isoformat()
+    params["period_end"] = json_period_end
+
+    json_date_grain = date_grain.value
+    params["date_grain"] = json_date_grain
+
+    json_dimension_id: None | str | Unset
+    if isinstance(dimension_id, Unset):
+        json_dimension_id = UNSET
+    else:
+        json_dimension_id = dimension_id
+    params["dimension_id"] = json_dimension_id
+
+    json_window_days: int | None | Unset
+    if isinstance(window_days, Unset):
+        json_window_days = UNSET
+    else:
+        json_window_days = window_days
+    params["window_days"] = json_window_days
+
+    params["projectId"] = project_id
+
+    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": "/v1/apps/analytics/kpis/timeseries",
+        "params": params,
+    }
+
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> HTTPValidationError | KpiTimeseriesResponse | None:
+    if response.status_code == 200:
+        response_200 = KpiTimeseriesResponse.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 | KpiTimeseriesResponse]:
+    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,
+    dimension: KpiSnapshotDimension,
+    kpi_name: str,
+    period_start: datetime.date,
+    period_end: datetime.date,
+    date_grain: DateGrain,
+    dimension_id: None | str | Unset = UNSET,
+    window_days: int | None | Unset = UNSET,
+    project_id: str,
+) -> Response[HTTPValidationError | KpiTimeseriesResponse]:
+    """Get Timeseries
+
+     Rolled-up KPI timeseries for one (dimension, dimension_id) pair.
+
+    For ``PORTFOLIO`` rollups pass ``dimension_id=None`` (omit the query
+    param). The aggregation rule comes from the KPI registry; DERIVED
+    KPIs compute ``derive_kpi(SUM_per_period(num), SUM_per_period(denom))``.
+
+    Returns 200 with an empty ``points`` list when the storage carries no
+    matching rows — including the CE-179 "skipped from snapshots" set
+    (``mean_daily_demand``, ``demand_volatility``, etc. live only on
+    ``inventory_item_kpis``).
+
+    Args:
+        dimension (KpiSnapshotDimension):
+        kpi_name (str):
+        period_start (datetime.date):
+        period_end (datetime.date):
+        date_grain (DateGrain): Date-grain bucket for ``get_kpi_timeseries`` rollup.
+
+            Maps 1:1 onto Postgres ``DATE_TRUNC`` units.
+        dimension_id (None | str | Unset):
+        window_days (int | None | Unset):
+        project_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[HTTPValidationError | KpiTimeseriesResponse]
+    """
+
+    kwargs = _get_kwargs(
+        dimension=dimension,
+        kpi_name=kpi_name,
+        period_start=period_start,
+        period_end=period_end,
+        date_grain=date_grain,
+        dimension_id=dimension_id,
+        window_days=window_days,
+        project_id=project_id,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient | Client,
+    dimension: KpiSnapshotDimension,
+    kpi_name: str,
+    period_start: datetime.date,
+    period_end: datetime.date,
+    date_grain: DateGrain,
+    dimension_id: None | str | Unset = UNSET,
+    window_days: int | None | Unset = UNSET,
+    project_id: str,
+) -> HTTPValidationError | KpiTimeseriesResponse | None:
+    """Get Timeseries
+
+     Rolled-up KPI timeseries for one (dimension, dimension_id) pair.
+
+    For ``PORTFOLIO`` rollups pass ``dimension_id=None`` (omit the query
+    param). The aggregation rule comes from the KPI registry; DERIVED
+    KPIs compute ``derive_kpi(SUM_per_period(num), SUM_per_period(denom))``.
+
+    Returns 200 with an empty ``points`` list when the storage carries no
+    matching rows — including the CE-179 "skipped from snapshots" set
+    (``mean_daily_demand``, ``demand_volatility``, etc. live only on
+    ``inventory_item_kpis``).
+
+    Args:
+        dimension (KpiSnapshotDimension):
+        kpi_name (str):
+        period_start (datetime.date):
+        period_end (datetime.date):
+        date_grain (DateGrain): Date-grain bucket for ``get_kpi_timeseries`` rollup.
+
+            Maps 1:1 onto Postgres ``DATE_TRUNC`` units.
+        dimension_id (None | str | Unset):
+        window_days (int | None | Unset):
+        project_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:
+        HTTPValidationError | KpiTimeseriesResponse
+    """
+
+    return sync_detailed(
+        client=client,
+        dimension=dimension,
+        kpi_name=kpi_name,
+        period_start=period_start,
+        period_end=period_end,
+        date_grain=date_grain,
+        dimension_id=dimension_id,
+        window_days=window_days,
+        project_id=project_id,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    dimension: KpiSnapshotDimension,
+    kpi_name: str,
+    period_start: datetime.date,
+    period_end: datetime.date,
+    date_grain: DateGrain,
+    dimension_id: None | str | Unset = UNSET,
+    window_days: int | None | Unset = UNSET,
+    project_id: str,
+) -> Response[HTTPValidationError | KpiTimeseriesResponse]:
+    """Get Timeseries
+
+     Rolled-up KPI timeseries for one (dimension, dimension_id) pair.
+
+    For ``PORTFOLIO`` rollups pass ``dimension_id=None`` (omit the query
+    param). The aggregation rule comes from the KPI registry; DERIVED
+    KPIs compute ``derive_kpi(SUM_per_period(num), SUM_per_period(denom))``.
+
+    Returns 200 with an empty ``points`` list when the storage carries no
+    matching rows — including the CE-179 "skipped from snapshots" set
+    (``mean_daily_demand``, ``demand_volatility``, etc. live only on
+    ``inventory_item_kpis``).
+
+    Args:
+        dimension (KpiSnapshotDimension):
+        kpi_name (str):
+        period_start (datetime.date):
+        period_end (datetime.date):
+        date_grain (DateGrain): Date-grain bucket for ``get_kpi_timeseries`` rollup.
+
+            Maps 1:1 onto Postgres ``DATE_TRUNC`` units.
+        dimension_id (None | str | Unset):
+        window_days (int | None | Unset):
+        project_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[HTTPValidationError | KpiTimeseriesResponse]
+    """
+
+    kwargs = _get_kwargs(
+        dimension=dimension,
+        kpi_name=kpi_name,
+        period_start=period_start,
+        period_end=period_end,
+        date_grain=date_grain,
+        dimension_id=dimension_id,
+        window_days=window_days,
+        project_id=project_id,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient | Client,
+    dimension: KpiSnapshotDimension,
+    kpi_name: str,
+    period_start: datetime.date,
+    period_end: datetime.date,
+    date_grain: DateGrain,
+    dimension_id: None | str | Unset = UNSET,
+    window_days: int | None | Unset = UNSET,
+    project_id: str,
+) -> HTTPValidationError | KpiTimeseriesResponse | None:
+    """Get Timeseries
+
+     Rolled-up KPI timeseries for one (dimension, dimension_id) pair.
+
+    For ``PORTFOLIO`` rollups pass ``dimension_id=None`` (omit the query
+    param). The aggregation rule comes from the KPI registry; DERIVED
+    KPIs compute ``derive_kpi(SUM_per_period(num), SUM_per_period(denom))``.
+
+    Returns 200 with an empty ``points`` list when the storage carries no
+    matching rows — including the CE-179 "skipped from snapshots" set
+    (``mean_daily_demand``, ``demand_volatility``, etc. live only on
+    ``inventory_item_kpis``).
+
+    Args:
+        dimension (KpiSnapshotDimension):
+        kpi_name (str):
+        period_start (datetime.date):
+        period_end (datetime.date):
+        date_grain (DateGrain): Date-grain bucket for ``get_kpi_timeseries`` rollup.
+
+            Maps 1:1 onto Postgres ``DATE_TRUNC`` units.
+        dimension_id (None | str | Unset):
+        window_days (int | None | Unset):
+        project_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:
+        HTTPValidationError | KpiTimeseriesResponse
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            dimension=dimension,
+            kpi_name=kpi_name,
+            period_start=period_start,
+            period_end=period_end,
+            date_grain=date_grain,
+            dimension_id=dimension_id,
+            window_days=window_days,
+            project_id=project_id,
+        )
+    ).parsed

convexity_api_client-0.21.0.dev374/convexity_api_client/api/v1/shopify_link_start_v1_shopify_link_start_post.py

@@ -0,0 +1,187 @@
+from http import HTTPStatus
+from typing import Any
+
+import httpx
+
+from ... import errors
+from ...client import AuthenticatedClient, Client
+from ...models.http_validation_error import HTTPValidationError
+from ...models.link_start_response import LinkStartResponse
+from ...types import UNSET, Response, Unset
+
+
+def _get_kwargs(
+    *,
+    authorization: None | str | Unset = UNSET,
+) -> dict[str, Any]:
+    headers: dict[str, Any] = {}
+    if not isinstance(authorization, Unset):
+        headers["authorization"] = authorization
+
+    _kwargs: dict[str, Any] = {
+        "method": "post",
+        "url": "/v1/shopify/link/start",
+    }
+
+    _kwargs["headers"] = headers
+    return _kwargs
+
+
+def _parse_response(
+    *, client: AuthenticatedClient | Client, response: httpx.Response
+) -> HTTPValidationError | LinkStartResponse | None:
+    if response.status_code == 200:
+        response_200 = LinkStartResponse.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 | LinkStartResponse]:
+    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,
+    authorization: None | str | Unset = UNSET,
+) -> Response[HTTPValidationError | LinkStartResponse]:
+    """Shopify Link Start
+
+     Mint a single-use link token for the "link to an existing project" flow.
+
+    The embedded app opens the frontend project-selection page
+    (``/connect/shopify/link``) with this token; that page consumes it via
+    ``POST /connections/shopify/link`` to bind the shop to the chosen project.
+
+    Args:
+        authorization (None | str | Unset):
+
+    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 | LinkStartResponse]
+    """
+
+    kwargs = _get_kwargs(
+        authorization=authorization,
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+
+def sync(
+    *,
+    client: AuthenticatedClient | Client,
+    authorization: None | str | Unset = UNSET,
+) -> HTTPValidationError | LinkStartResponse | None:
+    """Shopify Link Start
+
+     Mint a single-use link token for the "link to an existing project" flow.
+
+    The embedded app opens the frontend project-selection page
+    (``/connect/shopify/link``) with this token; that page consumes it via
+    ``POST /connections/shopify/link`` to bind the shop to the chosen project.
+
+    Args:
+        authorization (None | str | Unset):
+
+    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 | LinkStartResponse
+    """
+
+    return sync_detailed(
+        client=client,
+        authorization=authorization,
+    ).parsed
+
+
+async def asyncio_detailed(
+    *,
+    client: AuthenticatedClient | Client,
+    authorization: None | str | Unset = UNSET,
+) -> Response[HTTPValidationError | LinkStartResponse]:
+    """Shopify Link Start
+
+     Mint a single-use link token for the "link to an existing project" flow.
+
+    The embedded app opens the frontend project-selection page
+    (``/connect/shopify/link``) with this token; that page consumes it via
+    ``POST /connections/shopify/link`` to bind the shop to the chosen project.
+
+    Args:
+        authorization (None | str | Unset):
+
+    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 | LinkStartResponse]
+    """
+
+    kwargs = _get_kwargs(
+        authorization=authorization,
+    )
+
+    response = await client.get_async_httpx_client().request(**kwargs)
+
+    return _build_response(client=client, response=response)
+
+
+async def asyncio(
+    *,
+    client: AuthenticatedClient | Client,
+    authorization: None | str | Unset = UNSET,
+) -> HTTPValidationError | LinkStartResponse | None:
+    """Shopify Link Start
+
+     Mint a single-use link token for the "link to an existing project" flow.
+
+    The embedded app opens the frontend project-selection page
+    (``/connect/shopify/link``) with this token; that page consumes it via
+    ``POST /connections/shopify/link`` to bind the shop to the chosen project.
+
+    Args:
+        authorization (None | str | Unset):
+
+    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 | LinkStartResponse
+    """
+
+    return (
+        await asyncio_detailed(
+            client=client,
+            authorization=authorization,
+        )
+    ).parsed