Skip to content

katana_public_api_client.api.custom_fields.get_all_custom_fields_collections

katana_public_api_client.api.custom_fields.get_all_custom_fields_collections

Classes

Functions

asyncio(*, client) async

List all custom fields collections

Retrieves a list of custom fields collections.

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_fields_collections.py 
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
async def asyncio(
    *,
    client: AuthenticatedClient | Client,
) -> CustomFieldsCollectionListResponse | ErrorResponse | None:
    """List all custom fields collections

     Retrieves a list of custom fields collections.

    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[CustomFieldsCollectionListResponse, ErrorResponse]
    """

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

asyncio_detailed(*, client) async

List all custom fields collections

Retrieves a list of custom fields collections.

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_fields_collections.py 
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
async def asyncio_detailed(
    *,
    client: AuthenticatedClient | Client,
) -> Response[CustomFieldsCollectionListResponse | ErrorResponse]:
    """List all custom fields collections

     Retrieves a list of custom fields collections.

    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[CustomFieldsCollectionListResponse, ErrorResponse]]
    """

    kwargs = _get_kwargs()

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

    return _build_response(client=client, response=response)

sync(*, client)

List all custom fields collections

Retrieves a list of custom fields collections.

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_fields_collections.py 
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
def sync(
    *,
    client: AuthenticatedClient | Client,
) -> CustomFieldsCollectionListResponse | ErrorResponse | None:
    """List all custom fields collections

     Retrieves a list of custom fields collections.

    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[CustomFieldsCollectionListResponse, ErrorResponse]
    """

    return sync_detailed(
        client=client,
    ).parsed

sync_detailed(*, client)

List all custom fields collections

Retrieves a list of custom fields collections.

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_fields_collections.py 
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
def sync_detailed(
    *,
    client: AuthenticatedClient | Client,
) -> Response[CustomFieldsCollectionListResponse | ErrorResponse]:
    """List all custom fields collections

     Retrieves a list of custom fields collections.

    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[CustomFieldsCollectionListResponse, ErrorResponse]]
    """

    kwargs = _get_kwargs()

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

    return _build_response(client=client, response=response)