Skip to content

incident_io_client.api.custom_fields_v1.custom_fields_v1_list

asyncio async

asyncio(
    *, client: Union[AuthenticatedClient, Client]
) -> Optional[CustomFieldsV1ListResponseBody]

List Custom Fields V1

List all custom fields for an organisation.

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Optional[CustomFieldsV1ListResponseBody]

CustomFieldsV1ListResponseBody

Source code in incident_io_client/api/custom_fields_v1/custom_fields_v1_list.py
async def asyncio(
    *,
    client: Union[AuthenticatedClient, Client],
) -> Optional[CustomFieldsV1ListResponseBody]:
    """List Custom Fields V1

     List all custom fields for an organisation.

    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:
        CustomFieldsV1ListResponseBody
    """

    return (
        await asyncio_detailed(
            client=client,
        )
    ).parsed

asyncio_detailed async

asyncio_detailed(
    *, client: Union[AuthenticatedClient, Client]
) -> Response[CustomFieldsV1ListResponseBody]

List Custom Fields V1

List all custom fields for an organisation.

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Response[CustomFieldsV1ListResponseBody]

Response[CustomFieldsV1ListResponseBody]

Source code in incident_io_client/api/custom_fields_v1/custom_fields_v1_list.py
async def asyncio_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[CustomFieldsV1ListResponseBody]:
    """List Custom Fields V1

     List all custom fields for an organisation.

    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[CustomFieldsV1ListResponseBody]
    """

    kwargs = _get_kwargs()

    response = await client.get_async_httpx_client().request(**kwargs)

    return _build_response(client=client, response=response)

sync

sync(
    *, client: Union[AuthenticatedClient, Client]
) -> Optional[CustomFieldsV1ListResponseBody]

List Custom Fields V1

List all custom fields for an organisation.

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Optional[CustomFieldsV1ListResponseBody]

CustomFieldsV1ListResponseBody

Source code in incident_io_client/api/custom_fields_v1/custom_fields_v1_list.py
def sync(
    *,
    client: Union[AuthenticatedClient, Client],
) -> Optional[CustomFieldsV1ListResponseBody]:
    """List Custom Fields V1

     List all custom fields for an organisation.

    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:
        CustomFieldsV1ListResponseBody
    """

    return sync_detailed(
        client=client,
    ).parsed

sync_detailed

sync_detailed(
    *, client: Union[AuthenticatedClient, Client]
) -> Response[CustomFieldsV1ListResponseBody]

List Custom Fields V1

List all custom fields for an organisation.

Raises:

Type Description
UnexpectedStatus

If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.

TimeoutException

If the request takes longer than Client.timeout.

Returns:

Type Description
Response[CustomFieldsV1ListResponseBody]

Response[CustomFieldsV1ListResponseBody]

Source code in incident_io_client/api/custom_fields_v1/custom_fields_v1_list.py
def sync_detailed(
    *,
    client: Union[AuthenticatedClient, Client],
) -> Response[CustomFieldsV1ListResponseBody]:
    """List Custom Fields V1

     List all custom fields for an organisation.

    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[CustomFieldsV1ListResponseBody]
    """

    kwargs = _get_kwargs()

    response = client.get_httpx_client().request(
        **kwargs,
    )

    return _build_response(client=client, response=response)