Skip to content

katana_public_api_client.api.custom_fields.update_custom_field_definition

katana_public_api_client.api.custom_fields.update_custom_field_definition

Classes

Functions

asyncio(id, *, client, body) async

Update a custom field definition

Updates an existing custom field definition.

Parameters:

  • id (UUID) –
  • body (UpdateCustomFieldDefinitionRequest) –

    Request payload for updating an existing custom field definition. Only label, description, and options may be updated; field_type, entity_type, and source are immutable. Example: {'label': 'Quality Grade (revised)', 'description': 'Updated customer-facing quality classification'}.

Raises:

  • 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:

Source code in katana_public_api_client/api/custom_fields/update_custom_field_definition.py 
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
async def asyncio(
    id: UUID,
    *,
    client: AuthenticatedClient | Client,
    body: UpdateCustomFieldDefinitionRequest,
) -> CustomFieldDefinition | DetailedErrorResponse | ErrorResponse | None:
    """Update a custom field definition

     Updates an existing custom field definition.

    Args:
        id (UUID):
        body (UpdateCustomFieldDefinitionRequest): Request payload for updating an existing custom
            field definition.
            Only ``label``, ``description``, and ``options`` may be updated;
            ``field_type``, ``entity_type``, and ``source`` are immutable.
             Example: {'label': 'Quality Grade (revised)', 'description': 'Updated customer-facing
            quality classification'}.

    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:
        CustomFieldDefinition | DetailedErrorResponse | ErrorResponse
    """

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

asyncio_detailed(id, *, client, body) async

Update a custom field definition

Updates an existing custom field definition.

Parameters:

  • id (UUID) –
  • body (UpdateCustomFieldDefinitionRequest) –

    Request payload for updating an existing custom field definition. Only label, description, and options may be updated; field_type, entity_type, and source are immutable. Example: {'label': 'Quality Grade (revised)', 'description': 'Updated customer-facing quality classification'}.

Raises:

  • 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:

Source code in katana_public_api_client/api/custom_fields/update_custom_field_definition.py 
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
async def asyncio_detailed(
    id: UUID,
    *,
    client: AuthenticatedClient | Client,
    body: UpdateCustomFieldDefinitionRequest,
) -> Response[CustomFieldDefinition | DetailedErrorResponse | ErrorResponse]:
    """Update a custom field definition

     Updates an existing custom field definition.

    Args:
        id (UUID):
        body (UpdateCustomFieldDefinitionRequest): Request payload for updating an existing custom
            field definition.
            Only ``label``, ``description``, and ``options`` may be updated;
            ``field_type``, ``entity_type``, and ``source`` are immutable.
             Example: {'label': 'Quality Grade (revised)', 'description': 'Updated customer-facing
            quality classification'}.

    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[CustomFieldDefinition | DetailedErrorResponse | ErrorResponse]
    """

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

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

    return _build_response(client=client, response=response)

sync(id, *, client, body)

Update a custom field definition

Updates an existing custom field definition.

Parameters:

  • id (UUID) –
  • body (UpdateCustomFieldDefinitionRequest) –

    Request payload for updating an existing custom field definition. Only label, description, and options may be updated; field_type, entity_type, and source are immutable. Example: {'label': 'Quality Grade (revised)', 'description': 'Updated customer-facing quality classification'}.

Raises:

  • 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:

Source code in katana_public_api_client/api/custom_fields/update_custom_field_definition.py 
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
def sync(
    id: UUID,
    *,
    client: AuthenticatedClient | Client,
    body: UpdateCustomFieldDefinitionRequest,
) -> CustomFieldDefinition | DetailedErrorResponse | ErrorResponse | None:
    """Update a custom field definition

     Updates an existing custom field definition.

    Args:
        id (UUID):
        body (UpdateCustomFieldDefinitionRequest): Request payload for updating an existing custom
            field definition.
            Only ``label``, ``description``, and ``options`` may be updated;
            ``field_type``, ``entity_type``, and ``source`` are immutable.
             Example: {'label': 'Quality Grade (revised)', 'description': 'Updated customer-facing
            quality classification'}.

    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:
        CustomFieldDefinition | DetailedErrorResponse | ErrorResponse
    """

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

sync_detailed(id, *, client, body)

Update a custom field definition

Updates an existing custom field definition.

Parameters:

  • id (UUID) –
  • body (UpdateCustomFieldDefinitionRequest) –

    Request payload for updating an existing custom field definition. Only label, description, and options may be updated; field_type, entity_type, and source are immutable. Example: {'label': 'Quality Grade (revised)', 'description': 'Updated customer-facing quality classification'}.

Raises:

  • 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:

Source code in katana_public_api_client/api/custom_fields/update_custom_field_definition.py 
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
def sync_detailed(
    id: UUID,
    *,
    client: AuthenticatedClient | Client,
    body: UpdateCustomFieldDefinitionRequest,
) -> Response[CustomFieldDefinition | DetailedErrorResponse | ErrorResponse]:
    """Update a custom field definition

     Updates an existing custom field definition.

    Args:
        id (UUID):
        body (UpdateCustomFieldDefinitionRequest): Request payload for updating an existing custom
            field definition.
            Only ``label``, ``description``, and ``options`` may be updated;
            ``field_type``, ``entity_type``, and ``source`` are immutable.
             Example: {'label': 'Quality Grade (revised)', 'description': 'Updated customer-facing
            quality classification'}.

    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[CustomFieldDefinition | DetailedErrorResponse | ErrorResponse]
    """

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

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

    return _build_response(client=client, response=response)