incident_io_client.api.custom_fields_v2.custom_fields_v2_update

asyncio async

asyncio(
    id: str,
    *,
    client: Union[AuthenticatedClient, Client],
    body: CustomFieldsV2UpdateRequestBody
) -> Optional[CustomFieldsV2UpdateResponseBody]

Update Custom Fields V2

Update the details of a custom field

Parameters:

Name	Type	Description	Default
id	str		required
body	CustomFieldsV2UpdateRequestBody	Example: {'description': 'Which team is impacted by this issue', 'name': 'Affected Team'}.	required

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[CustomFieldsV2UpdateResponseBody]	CustomFieldsV2UpdateResponseBody

Source code in incident_io_client/api/custom_fields_v2/custom_fields_v2_update.py

async def asyncio(
    id: str,
    *,
    client: Union[AuthenticatedClient, Client],
    body: CustomFieldsV2UpdateRequestBody,
) -> Optional[CustomFieldsV2UpdateResponseBody]:
    """Update Custom Fields V2

     Update the details of a custom field

    Args:
        id (str):
        body (CustomFieldsV2UpdateRequestBody):  Example: {'description': 'Which team is impacted
            by this issue', 'name': 'Affected Team'}.

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

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

asyncio_detailed async

asyncio_detailed(
    id: str,
    *,
    client: Union[AuthenticatedClient, Client],
    body: CustomFieldsV2UpdateRequestBody
) -> Response[CustomFieldsV2UpdateResponseBody]

Update Custom Fields V2

Update the details of a custom field

Parameters:

Name	Type	Description	Default
id	str		required
body	CustomFieldsV2UpdateRequestBody	Example: {'description': 'Which team is impacted by this issue', 'name': 'Affected Team'}.	required

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[CustomFieldsV2UpdateResponseBody]	Response[CustomFieldsV2UpdateResponseBody]

Source code in incident_io_client/api/custom_fields_v2/custom_fields_v2_update.py

async def asyncio_detailed(
    id: str,
    *,
    client: Union[AuthenticatedClient, Client],
    body: CustomFieldsV2UpdateRequestBody,
) -> Response[CustomFieldsV2UpdateResponseBody]:
    """Update Custom Fields V2

     Update the details of a custom field

    Args:
        id (str):
        body (CustomFieldsV2UpdateRequestBody):  Example: {'description': 'Which team is impacted
            by this issue', 'name': 'Affected Team'}.

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

    kwargs = _get_kwargs(
        id=id,
        body=body,
    )

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

    return _build_response(client=client, response=response)

sync

sync(
    id: str,
    *,
    client: Union[AuthenticatedClient, Client],
    body: CustomFieldsV2UpdateRequestBody
) -> Optional[CustomFieldsV2UpdateResponseBody]

Update Custom Fields V2

Update the details of a custom field

Parameters:

Name	Type	Description	Default
id	str		required
body	CustomFieldsV2UpdateRequestBody	Example: {'description': 'Which team is impacted by this issue', 'name': 'Affected Team'}.	required

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[CustomFieldsV2UpdateResponseBody]	CustomFieldsV2UpdateResponseBody

Source code in incident_io_client/api/custom_fields_v2/custom_fields_v2_update.py

def sync(
    id: str,
    *,
    client: Union[AuthenticatedClient, Client],
    body: CustomFieldsV2UpdateRequestBody,
) -> Optional[CustomFieldsV2UpdateResponseBody]:
    """Update Custom Fields V2

     Update the details of a custom field

    Args:
        id (str):
        body (CustomFieldsV2UpdateRequestBody):  Example: {'description': 'Which team is impacted
            by this issue', 'name': 'Affected Team'}.

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

    return sync_detailed(
        id=id,
        client=client,
        body=body,
    ).parsed

sync_detailed

sync_detailed(
    id: str,
    *,
    client: Union[AuthenticatedClient, Client],
    body: CustomFieldsV2UpdateRequestBody
) -> Response[CustomFieldsV2UpdateResponseBody]

Update Custom Fields V2

Update the details of a custom field

Parameters:

Name	Type	Description	Default
id	str		required
body	CustomFieldsV2UpdateRequestBody	Example: {'description': 'Which team is impacted by this issue', 'name': 'Affected Team'}.	required

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[CustomFieldsV2UpdateResponseBody]	Response[CustomFieldsV2UpdateResponseBody]

Source code in incident_io_client/api/custom_fields_v2/custom_fields_v2_update.py

def sync_detailed(
    id: str,
    *,
    client: Union[AuthenticatedClient, Client],
    body: CustomFieldsV2UpdateRequestBody,
) -> Response[CustomFieldsV2UpdateResponseBody]:
    """Update Custom Fields V2

     Update the details of a custom field

    Args:
        id (str):
        body (CustomFieldsV2UpdateRequestBody):  Example: {'description': 'Which team is impacted
            by this issue', 'name': 'Affected Team'}.

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

    kwargs = _get_kwargs(
        id=id,
        body=body,
    )

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

    return _build_response(client=client, response=response)