Skip to content

katana_public_api_client.api.custom_fields.get_all_custom_field_definitions

katana_public_api_client.api.custom_fields.get_all_custom_field_definitions

Classes

Functions

asyncio(*, client, limit=UNSET, page=UNSET, created_at_min=UNSET, created_at_max=UNSET, updated_at_min=UNSET, updated_at_max=UNSET, label=UNSET, field_type=UNSET, entity_type=UNSET) async

List custom field definitions

Returns a paginated list of custom field definitions. Each definition configures a custom field that callers can attach to a resource (sales order, service, product, etc.) via the resource's custom_fields property.

Parameters:

  • limit (int | Unset, default: UNSET ) –

    Default: 50.

  • page (int | Unset, default: UNSET ) –

    Default: 1.

  • created_at_min (datetime | Unset, default: UNSET ) –
  • created_at_max (datetime | Unset, default: UNSET ) –
  • updated_at_min (datetime | Unset, default: UNSET ) –
  • updated_at_max (datetime | Unset, default: UNSET ) –
  • label (str | Unset, default: UNSET ) –
  • field_type (str | Unset, default: UNSET ) –
  • entity_type (str | Unset, default: UNSET ) –

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/get_all_custom_field_definitions.py 
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
async def asyncio(
    *,
    client: AuthenticatedClient | Client,
    limit: int | Unset = UNSET,
    page: int | Unset = UNSET,
    created_at_min: datetime.datetime | Unset = UNSET,
    created_at_max: datetime.datetime | Unset = UNSET,
    updated_at_min: datetime.datetime | Unset = UNSET,
    updated_at_max: datetime.datetime | Unset = UNSET,
    label: str | Unset = UNSET,
    field_type: str | Unset = UNSET,
    entity_type: str | Unset = UNSET,
) -> CustomFieldDefinitionListResponse | ErrorResponse | None:
    """List custom field definitions

     Returns a paginated list of custom field definitions. Each definition
    configures a custom field that callers can attach to a resource (sales
    order, service, product, etc.) via the resource's ``custom_fields``
    property.

    Args:
        limit (int | Unset):  Default: 50.
        page (int | Unset):  Default: 1.
        created_at_min (datetime.datetime | Unset):
        created_at_max (datetime.datetime | Unset):
        updated_at_min (datetime.datetime | Unset):
        updated_at_max (datetime.datetime | Unset):
        label (str | Unset):
        field_type (str | Unset):
        entity_type (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:
        CustomFieldDefinitionListResponse | ErrorResponse
    """

    return (
        await asyncio_detailed(
            client=client,
            limit=limit,
            page=page,
            created_at_min=created_at_min,
            created_at_max=created_at_max,
            updated_at_min=updated_at_min,
            updated_at_max=updated_at_max,
            label=label,
            field_type=field_type,
            entity_type=entity_type,
        )
    ).parsed

asyncio_detailed(*, client, limit=UNSET, page=UNSET, created_at_min=UNSET, created_at_max=UNSET, updated_at_min=UNSET, updated_at_max=UNSET, label=UNSET, field_type=UNSET, entity_type=UNSET) async

List custom field definitions

Returns a paginated list of custom field definitions. Each definition configures a custom field that callers can attach to a resource (sales order, service, product, etc.) via the resource's custom_fields property.

Parameters:

  • limit (int | Unset, default: UNSET ) –

    Default: 50.

  • page (int | Unset, default: UNSET ) –

    Default: 1.

  • created_at_min (datetime | Unset, default: UNSET ) –
  • created_at_max (datetime | Unset, default: UNSET ) –
  • updated_at_min (datetime | Unset, default: UNSET ) –
  • updated_at_max (datetime | Unset, default: UNSET ) –
  • label (str | Unset, default: UNSET ) –
  • field_type (str | Unset, default: UNSET ) –
  • entity_type (str | Unset, default: UNSET ) –

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/get_all_custom_field_definitions.py 
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
async def asyncio_detailed(
    *,
    client: AuthenticatedClient | Client,
    limit: int | Unset = UNSET,
    page: int | Unset = UNSET,
    created_at_min: datetime.datetime | Unset = UNSET,
    created_at_max: datetime.datetime | Unset = UNSET,
    updated_at_min: datetime.datetime | Unset = UNSET,
    updated_at_max: datetime.datetime | Unset = UNSET,
    label: str | Unset = UNSET,
    field_type: str | Unset = UNSET,
    entity_type: str | Unset = UNSET,
) -> Response[CustomFieldDefinitionListResponse | ErrorResponse]:
    """List custom field definitions

     Returns a paginated list of custom field definitions. Each definition
    configures a custom field that callers can attach to a resource (sales
    order, service, product, etc.) via the resource's ``custom_fields``
    property.

    Args:
        limit (int | Unset):  Default: 50.
        page (int | Unset):  Default: 1.
        created_at_min (datetime.datetime | Unset):
        created_at_max (datetime.datetime | Unset):
        updated_at_min (datetime.datetime | Unset):
        updated_at_max (datetime.datetime | Unset):
        label (str | Unset):
        field_type (str | Unset):
        entity_type (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[CustomFieldDefinitionListResponse | ErrorResponse]
    """

    kwargs = _get_kwargs(
        limit=limit,
        page=page,
        created_at_min=created_at_min,
        created_at_max=created_at_max,
        updated_at_min=updated_at_min,
        updated_at_max=updated_at_max,
        label=label,
        field_type=field_type,
        entity_type=entity_type,
    )

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

    return _build_response(client=client, response=response)

sync(*, client, limit=UNSET, page=UNSET, created_at_min=UNSET, created_at_max=UNSET, updated_at_min=UNSET, updated_at_max=UNSET, label=UNSET, field_type=UNSET, entity_type=UNSET)

List custom field definitions

Returns a paginated list of custom field definitions. Each definition configures a custom field that callers can attach to a resource (sales order, service, product, etc.) via the resource's custom_fields property.

Parameters:

  • limit (int | Unset, default: UNSET ) –

    Default: 50.

  • page (int | Unset, default: UNSET ) –

    Default: 1.

  • created_at_min (datetime | Unset, default: UNSET ) –
  • created_at_max (datetime | Unset, default: UNSET ) –
  • updated_at_min (datetime | Unset, default: UNSET ) –
  • updated_at_max (datetime | Unset, default: UNSET ) –
  • label (str | Unset, default: UNSET ) –
  • field_type (str | Unset, default: UNSET ) –
  • entity_type (str | Unset, default: UNSET ) –

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/get_all_custom_field_definitions.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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
def sync(
    *,
    client: AuthenticatedClient | Client,
    limit: int | Unset = UNSET,
    page: int | Unset = UNSET,
    created_at_min: datetime.datetime | Unset = UNSET,
    created_at_max: datetime.datetime | Unset = UNSET,
    updated_at_min: datetime.datetime | Unset = UNSET,
    updated_at_max: datetime.datetime | Unset = UNSET,
    label: str | Unset = UNSET,
    field_type: str | Unset = UNSET,
    entity_type: str | Unset = UNSET,
) -> CustomFieldDefinitionListResponse | ErrorResponse | None:
    """List custom field definitions

     Returns a paginated list of custom field definitions. Each definition
    configures a custom field that callers can attach to a resource (sales
    order, service, product, etc.) via the resource's ``custom_fields``
    property.

    Args:
        limit (int | Unset):  Default: 50.
        page (int | Unset):  Default: 1.
        created_at_min (datetime.datetime | Unset):
        created_at_max (datetime.datetime | Unset):
        updated_at_min (datetime.datetime | Unset):
        updated_at_max (datetime.datetime | Unset):
        label (str | Unset):
        field_type (str | Unset):
        entity_type (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:
        CustomFieldDefinitionListResponse | ErrorResponse
    """

    return sync_detailed(
        client=client,
        limit=limit,
        page=page,
        created_at_min=created_at_min,
        created_at_max=created_at_max,
        updated_at_min=updated_at_min,
        updated_at_max=updated_at_max,
        label=label,
        field_type=field_type,
        entity_type=entity_type,
    ).parsed

sync_detailed(*, client, limit=UNSET, page=UNSET, created_at_min=UNSET, created_at_max=UNSET, updated_at_min=UNSET, updated_at_max=UNSET, label=UNSET, field_type=UNSET, entity_type=UNSET)

List custom field definitions

Returns a paginated list of custom field definitions. Each definition configures a custom field that callers can attach to a resource (sales order, service, product, etc.) via the resource's custom_fields property.

Parameters:

  • limit (int | Unset, default: UNSET ) –

    Default: 50.

  • page (int | Unset, default: UNSET ) –

    Default: 1.

  • created_at_min (datetime | Unset, default: UNSET ) –
  • created_at_max (datetime | Unset, default: UNSET ) –
  • updated_at_min (datetime | Unset, default: UNSET ) –
  • updated_at_max (datetime | Unset, default: UNSET ) –
  • label (str | Unset, default: UNSET ) –
  • field_type (str | Unset, default: UNSET ) –
  • entity_type (str | Unset, default: UNSET ) –

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/get_all_custom_field_definitions.py 
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
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_detailed(
    *,
    client: AuthenticatedClient | Client,
    limit: int | Unset = UNSET,
    page: int | Unset = UNSET,
    created_at_min: datetime.datetime | Unset = UNSET,
    created_at_max: datetime.datetime | Unset = UNSET,
    updated_at_min: datetime.datetime | Unset = UNSET,
    updated_at_max: datetime.datetime | Unset = UNSET,
    label: str | Unset = UNSET,
    field_type: str | Unset = UNSET,
    entity_type: str | Unset = UNSET,
) -> Response[CustomFieldDefinitionListResponse | ErrorResponse]:
    """List custom field definitions

     Returns a paginated list of custom field definitions. Each definition
    configures a custom field that callers can attach to a resource (sales
    order, service, product, etc.) via the resource's ``custom_fields``
    property.

    Args:
        limit (int | Unset):  Default: 50.
        page (int | Unset):  Default: 1.
        created_at_min (datetime.datetime | Unset):
        created_at_max (datetime.datetime | Unset):
        updated_at_min (datetime.datetime | Unset):
        updated_at_max (datetime.datetime | Unset):
        label (str | Unset):
        field_type (str | Unset):
        entity_type (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[CustomFieldDefinitionListResponse | ErrorResponse]
    """

    kwargs = _get_kwargs(
        limit=limit,
        page=page,
        created_at_min=created_at_min,
        created_at_max=created_at_max,
        updated_at_min=updated_at_min,
        updated_at_max=updated_at_max,
        label=label,
        field_type=field_type,
        entity_type=entity_type,
    )

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

    return _build_response(client=client, response=response)