field-manager-python-client 4.4.82rc1__py3-none-any.whl

field-manager-python-client/__init__.py

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

field-manager-python-client/api/__init__.py

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

field-manager-python-client/api/bff/get_files_in_project_projects_project_id_bff_files_get.py

@@ -0,0 +1,222 @@
+from http import HTTPStatus
+from typing import Any, Dict, List, Optional, Union, cast
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.bff_file import BFFFile
+from ...models.file_type import FileType
+from ...models.http_validation_error import HTTPValidationError
+from ...types import UNSET, Unset
+from typing import cast
+from typing import cast, List
+from typing import Dict
+from typing import Union
+
+
+
+def _get_kwargs(
+    project_id: str,
+    *,
+    file_types: Union[Unset, List[FileType]] = UNSET,
+
+) -> Dict[str, Any]:
+    
+
+    
+
+    params: Dict[str, Any] = {}
+
+    json_file_types: Union[Unset, List[str]] = UNSET
+    if not isinstance(file_types, Unset):
+        json_file_types = []
+        for file_types_item_data in file_types:
+            file_types_item = file_types_item_data.value
+            json_file_types.append(file_types_item)
+
+
+    params["file_types"] = json_file_types
+
+
+    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": "/projects/{project_id}/bff/files".format(project_id=project_id,),
+        "params": params,
+    }
+
+
+    return _kwargs
+
+
+def _parse_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Optional[Union[HTTPValidationError, List['BFFFile']]]:
+    if response.status_code == 200:
+        response_200 = []
+        _response_200 = response.json()
+        for response_200_item_data in (_response_200):
+            response_200_item = BFFFile.from_dict(response_200_item_data)
+
+
+
+            response_200.append(response_200_item)
+
+        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: Union[AuthenticatedClient, Client], response: httpx.Response) -> Response[Union[HTTPValidationError, List['BFFFile']]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    project_id: str,
+    *,
+    client: AuthenticatedClient,
+    file_types: Union[Unset, List[FileType]] = UNSET,
+
+) -> Response[Union[HTTPValidationError, List['BFFFile']]]:
+    """ Get Files In Project
+
+     Get all database file objects in a project by project_id and possible filtered by file type.
+
+    Args:
+        project_id (str):
+        file_types (Union[Unset, List[FileType]]):
+
+    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[Union[HTTPValidationError, List['BFFFile']]]
+     """
+
+
+    kwargs = _get_kwargs(
+        project_id=project_id,
+file_types=file_types,
+
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+def sync(
+    project_id: str,
+    *,
+    client: AuthenticatedClient,
+    file_types: Union[Unset, List[FileType]] = UNSET,
+
+) -> Optional[Union[HTTPValidationError, List['BFFFile']]]:
+    """ Get Files In Project
+
+     Get all database file objects in a project by project_id and possible filtered by file type.
+
+    Args:
+        project_id (str):
+        file_types (Union[Unset, List[FileType]]):
+
+    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:
+        Union[HTTPValidationError, List['BFFFile']]
+     """
+
+
+    return sync_detailed(
+        project_id=project_id,
+client=client,
+file_types=file_types,
+
+    ).parsed
+
+async def asyncio_detailed(
+    project_id: str,
+    *,
+    client: AuthenticatedClient,
+    file_types: Union[Unset, List[FileType]] = UNSET,
+
+) -> Response[Union[HTTPValidationError, List['BFFFile']]]:
+    """ Get Files In Project
+
+     Get all database file objects in a project by project_id and possible filtered by file type.
+
+    Args:
+        project_id (str):
+        file_types (Union[Unset, List[FileType]]):
+
+    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[Union[HTTPValidationError, List['BFFFile']]]
+     """
+
+
+    kwargs = _get_kwargs(
+        project_id=project_id,
+file_types=file_types,
+
+    )
+
+    response = await client.get_async_httpx_client().request(
+        **kwargs
+    )
+
+    return _build_response(client=client, response=response)
+
+async def asyncio(
+    project_id: str,
+    *,
+    client: AuthenticatedClient,
+    file_types: Union[Unset, List[FileType]] = UNSET,
+
+) -> Optional[Union[HTTPValidationError, List['BFFFile']]]:
+    """ Get Files In Project
+
+     Get all database file objects in a project by project_id and possible filtered by file type.
+
+    Args:
+        project_id (str):
+        file_types (Union[Unset, List[FileType]]):
+
+    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:
+        Union[HTTPValidationError, List['BFFFile']]
+     """
+
+
+    return (await asyncio_detailed(
+        project_id=project_id,
+client=client,
+file_types=file_types,
+
+    )).parsed

field-manager-python-client/api/bff/get_location_summaries_projects_project_id_location_summaries_get.py

@@ -0,0 +1,198 @@
+from http import HTTPStatus
+from typing import Any, Dict, List, Optional, Union, cast
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.bff_location_summary import BFFLocationSummary
+from ...models.http_validation_error import HTTPValidationError
+from typing import cast
+from typing import cast, List
+from typing import Dict
+
+
+
+def _get_kwargs(
+    project_id: str,
+
+) -> Dict[str, Any]:
+    
+
+    
+
+    
+
+    _kwargs: Dict[str, Any] = {
+        "method": "get",
+        "url": "/projects/{project_id}/location_summaries".format(project_id=project_id,),
+    }
+
+
+    return _kwargs
+
+
+def _parse_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Optional[Union[HTTPValidationError, List['BFFLocationSummary']]]:
+    if response.status_code == 200:
+        response_200 = []
+        _response_200 = response.json()
+        for response_200_item_data in (_response_200):
+            response_200_item = BFFLocationSummary.from_dict(response_200_item_data)
+
+
+
+            response_200.append(response_200_item)
+
+        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: Union[AuthenticatedClient, Client], response: httpx.Response) -> Response[Union[HTTPValidationError, List['BFFLocationSummary']]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    project_id: str,
+    *,
+    client: AuthenticatedClient,
+
+) -> Response[Union[HTTPValidationError, List['BFFLocationSummary']]]:
+    """ Get Location Summaries
+
+     This is a very heavy and specialized endpoint, only returning exactly what is needed for displaying
+    information
+    in the map (Locations, Methods and some numbers shown for the location in the map).
+
+    Args:
+        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[Union[HTTPValidationError, List['BFFLocationSummary']]]
+     """
+
+
+    kwargs = _get_kwargs(
+        project_id=project_id,
+
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+def sync(
+    project_id: str,
+    *,
+    client: AuthenticatedClient,
+
+) -> Optional[Union[HTTPValidationError, List['BFFLocationSummary']]]:
+    """ Get Location Summaries
+
+     This is a very heavy and specialized endpoint, only returning exactly what is needed for displaying
+    information
+    in the map (Locations, Methods and some numbers shown for the location in the map).
+
+    Args:
+        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:
+        Union[HTTPValidationError, List['BFFLocationSummary']]
+     """
+
+
+    return sync_detailed(
+        project_id=project_id,
+client=client,
+
+    ).parsed
+
+async def asyncio_detailed(
+    project_id: str,
+    *,
+    client: AuthenticatedClient,
+
+) -> Response[Union[HTTPValidationError, List['BFFLocationSummary']]]:
+    """ Get Location Summaries
+
+     This is a very heavy and specialized endpoint, only returning exactly what is needed for displaying
+    information
+    in the map (Locations, Methods and some numbers shown for the location in the map).
+
+    Args:
+        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[Union[HTTPValidationError, List['BFFLocationSummary']]]
+     """
+
+
+    kwargs = _get_kwargs(
+        project_id=project_id,
+
+    )
+
+    response = await client.get_async_httpx_client().request(
+        **kwargs
+    )
+
+    return _build_response(client=client, response=response)
+
+async def asyncio(
+    project_id: str,
+    *,
+    client: AuthenticatedClient,
+
+) -> Optional[Union[HTTPValidationError, List['BFFLocationSummary']]]:
+    """ Get Location Summaries
+
+     This is a very heavy and specialized endpoint, only returning exactly what is needed for displaying
+    information
+    in the map (Locations, Methods and some numbers shown for the location in the map).
+
+    Args:
+        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:
+        Union[HTTPValidationError, List['BFFLocationSummary']]
+     """
+
+
+    return (await asyncio_detailed(
+        project_id=project_id,
+client=client,
+
+    )).parsed

field-manager-python-client/api/bff/get_project_location_methodtypes_summary_organizations_organization_id_projectlocationmethodtypes_get.py

@@ -0,0 +1,194 @@
+from http import HTTPStatus
+from typing import Any, Dict, List, Optional, Union, cast
+
+import httpx
+
+from ...client import AuthenticatedClient, Client
+from ...types import Response, UNSET
+from ... import errors
+
+from ...models.http_validation_error import HTTPValidationError
+from ...models.project_location_method_types import ProjectLocationMethodTypes
+from typing import cast
+from typing import cast, List
+from typing import Dict
+
+
+
+def _get_kwargs(
+    organization_id: str,
+
+) -> Dict[str, Any]:
+    
+
+    
+
+    
+
+    _kwargs: Dict[str, Any] = {
+        "method": "get",
+        "url": "/organizations/{organization_id}/projectlocationmethodtypes".format(organization_id=organization_id,),
+    }
+
+
+    return _kwargs
+
+
+def _parse_response(*, client: Union[AuthenticatedClient, Client], response: httpx.Response) -> Optional[Union[HTTPValidationError, List['ProjectLocationMethodTypes']]]:
+    if response.status_code == 200:
+        response_200 = []
+        _response_200 = response.json()
+        for response_200_item_data in (_response_200):
+            response_200_item = ProjectLocationMethodTypes.from_dict(response_200_item_data)
+
+
+
+            response_200.append(response_200_item)
+
+        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: Union[AuthenticatedClient, Client], response: httpx.Response) -> Response[Union[HTTPValidationError, List['ProjectLocationMethodTypes']]]:
+    return Response(
+        status_code=HTTPStatus(response.status_code),
+        content=response.content,
+        headers=response.headers,
+        parsed=_parse_response(client=client, response=response),
+    )
+
+
+def sync_detailed(
+    organization_id: str,
+    *,
+    client: AuthenticatedClient,
+
+) -> Response[Union[HTTPValidationError, List['ProjectLocationMethodTypes']]]:
+    """ Get Project Location Methodtypes Summary
+
+     Gets a summary of all methodtypes for every location in every project for the given organization
+    Used primarily for building elastic index for search in Geodata Explorer
+
+    Args:
+        organization_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[Union[HTTPValidationError, List['ProjectLocationMethodTypes']]]
+     """
+
+
+    kwargs = _get_kwargs(
+        organization_id=organization_id,
+
+    )
+
+    response = client.get_httpx_client().request(
+        **kwargs,
+    )
+
+    return _build_response(client=client, response=response)
+
+def sync(
+    organization_id: str,
+    *,
+    client: AuthenticatedClient,
+
+) -> Optional[Union[HTTPValidationError, List['ProjectLocationMethodTypes']]]:
+    """ Get Project Location Methodtypes Summary
+
+     Gets a summary of all methodtypes for every location in every project for the given organization
+    Used primarily for building elastic index for search in Geodata Explorer
+
+    Args:
+        organization_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:
+        Union[HTTPValidationError, List['ProjectLocationMethodTypes']]
+     """
+
+
+    return sync_detailed(
+        organization_id=organization_id,
+client=client,
+
+    ).parsed
+
+async def asyncio_detailed(
+    organization_id: str,
+    *,
+    client: AuthenticatedClient,
+
+) -> Response[Union[HTTPValidationError, List['ProjectLocationMethodTypes']]]:
+    """ Get Project Location Methodtypes Summary
+
+     Gets a summary of all methodtypes for every location in every project for the given organization
+    Used primarily for building elastic index for search in Geodata Explorer
+
+    Args:
+        organization_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[Union[HTTPValidationError, List['ProjectLocationMethodTypes']]]
+     """
+
+
+    kwargs = _get_kwargs(
+        organization_id=organization_id,
+
+    )
+
+    response = await client.get_async_httpx_client().request(
+        **kwargs
+    )
+
+    return _build_response(client=client, response=response)
+
+async def asyncio(
+    organization_id: str,
+    *,
+    client: AuthenticatedClient,
+
+) -> Optional[Union[HTTPValidationError, List['ProjectLocationMethodTypes']]]:
+    """ Get Project Location Methodtypes Summary
+
+     Gets a summary of all methodtypes for every location in every project for the given organization
+    Used primarily for building elastic index for search in Geodata Explorer
+
+    Args:
+        organization_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:
+        Union[HTTPValidationError, List['ProjectLocationMethodTypes']]
+     """
+
+
+    return (await asyncio_detailed(
+        organization_id=organization_id,
+client=client,
+
+    )).parsed