Skip to content

katana_public_api_client.api.customer.get_all_customers

katana_public_api_client.api.customer.get_all_customers

Classes

Functions

asyncio(*, client, limit=50, page=1, ids=UNSET, include_deleted=UNSET, created_at_min=UNSET, created_at_max=UNSET, updated_at_min=UNSET, updated_at_max=UNSET, name=UNSET, email=UNSET, first_name=UNSET, last_name=UNSET, company=UNSET, phone=UNSET, category=UNSET, currency=UNSET, reference_id=UNSET) async

List all customers

Returns a list of customers you've previously created.

Parameters:

  • limit (Union[Unset, int], default: 50 ) –

    Default: 50.

  • page (Union[Unset, int], default: 1 ) –

    Default: 1.

  • ids (Union[Unset, list[int]], default: UNSET ) –
  • include_deleted (Union[Unset, bool], default: UNSET ) –
  • created_at_min (Union[Unset, datetime], default: UNSET ) –
  • created_at_max (Union[Unset, datetime], default: UNSET ) –
  • updated_at_min (Union[Unset, datetime], default: UNSET ) –
  • updated_at_max (Union[Unset, datetime], default: UNSET ) –
  • name (Union[Unset, str], default: UNSET ) –
  • email (Union[Unset, str], default: UNSET ) –
  • first_name (Union[Unset, str], default: UNSET ) –
  • last_name (Union[Unset, str], default: UNSET ) –
  • company (Union[Unset, str], default: UNSET ) –
  • phone (Union[Unset, str], default: UNSET ) –
  • category (Union[Unset, str], default: UNSET ) –
  • currency (Union[Unset, str], default: UNSET ) –
  • reference_id (Union[Unset, str], 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/customer/get_all_customers.py 
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
async def asyncio(
    *,
    client: AuthenticatedClient | Client,
    limit: Unset | int = 50,
    page: Unset | int = 1,
    ids: Unset | list[int] = UNSET,
    include_deleted: Unset | bool = UNSET,
    created_at_min: Unset | datetime.datetime = UNSET,
    created_at_max: Unset | datetime.datetime = UNSET,
    updated_at_min: Unset | datetime.datetime = UNSET,
    updated_at_max: Unset | datetime.datetime = UNSET,
    name: Unset | str = UNSET,
    email: Unset | str = UNSET,
    first_name: Unset | str = UNSET,
    last_name: Unset | str = UNSET,
    company: Unset | str = UNSET,
    phone: Unset | str = UNSET,
    category: Unset | str = UNSET,
    currency: Unset | str = UNSET,
    reference_id: Unset | str = UNSET,
) -> CustomerListResponse | ErrorResponse | None:
    """List all customers

     Returns a list of customers you've previously created.

    Args:
        limit (Union[Unset, int]):  Default: 50.
        page (Union[Unset, int]):  Default: 1.
        ids (Union[Unset, list[int]]):
        include_deleted (Union[Unset, bool]):
        created_at_min (Union[Unset, datetime.datetime]):
        created_at_max (Union[Unset, datetime.datetime]):
        updated_at_min (Union[Unset, datetime.datetime]):
        updated_at_max (Union[Unset, datetime.datetime]):
        name (Union[Unset, str]):
        email (Union[Unset, str]):
        first_name (Union[Unset, str]):
        last_name (Union[Unset, str]):
        company (Union[Unset, str]):
        phone (Union[Unset, str]):
        category (Union[Unset, str]):
        currency (Union[Unset, str]):
        reference_id (Union[Unset, str]):

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

    return (
        await asyncio_detailed(
            client=client,
            limit=limit,
            page=page,
            ids=ids,
            include_deleted=include_deleted,
            created_at_min=created_at_min,
            created_at_max=created_at_max,
            updated_at_min=updated_at_min,
            updated_at_max=updated_at_max,
            name=name,
            email=email,
            first_name=first_name,
            last_name=last_name,
            company=company,
            phone=phone,
            category=category,
            currency=currency,
            reference_id=reference_id,
        )
    ).parsed

asyncio_detailed(*, client, limit=50, page=1, ids=UNSET, include_deleted=UNSET, created_at_min=UNSET, created_at_max=UNSET, updated_at_min=UNSET, updated_at_max=UNSET, name=UNSET, email=UNSET, first_name=UNSET, last_name=UNSET, company=UNSET, phone=UNSET, category=UNSET, currency=UNSET, reference_id=UNSET) async

List all customers

Returns a list of customers you've previously created.

Parameters:

  • limit (Union[Unset, int], default: 50 ) –

    Default: 50.

  • page (Union[Unset, int], default: 1 ) –

    Default: 1.

  • ids (Union[Unset, list[int]], default: UNSET ) –
  • include_deleted (Union[Unset, bool], default: UNSET ) –
  • created_at_min (Union[Unset, datetime], default: UNSET ) –
  • created_at_max (Union[Unset, datetime], default: UNSET ) –
  • updated_at_min (Union[Unset, datetime], default: UNSET ) –
  • updated_at_max (Union[Unset, datetime], default: UNSET ) –
  • name (Union[Unset, str], default: UNSET ) –
  • email (Union[Unset, str], default: UNSET ) –
  • first_name (Union[Unset, str], default: UNSET ) –
  • last_name (Union[Unset, str], default: UNSET ) –
  • company (Union[Unset, str], default: UNSET ) –
  • phone (Union[Unset, str], default: UNSET ) –
  • category (Union[Unset, str], default: UNSET ) –
  • currency (Union[Unset, str], default: UNSET ) –
  • reference_id (Union[Unset, str], 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/customer/get_all_customers.py 
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
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
async def asyncio_detailed(
    *,
    client: AuthenticatedClient | Client,
    limit: Unset | int = 50,
    page: Unset | int = 1,
    ids: Unset | list[int] = UNSET,
    include_deleted: Unset | bool = UNSET,
    created_at_min: Unset | datetime.datetime = UNSET,
    created_at_max: Unset | datetime.datetime = UNSET,
    updated_at_min: Unset | datetime.datetime = UNSET,
    updated_at_max: Unset | datetime.datetime = UNSET,
    name: Unset | str = UNSET,
    email: Unset | str = UNSET,
    first_name: Unset | str = UNSET,
    last_name: Unset | str = UNSET,
    company: Unset | str = UNSET,
    phone: Unset | str = UNSET,
    category: Unset | str = UNSET,
    currency: Unset | str = UNSET,
    reference_id: Unset | str = UNSET,
) -> Response[CustomerListResponse | ErrorResponse]:
    """List all customers

     Returns a list of customers you've previously created.

    Args:
        limit (Union[Unset, int]):  Default: 50.
        page (Union[Unset, int]):  Default: 1.
        ids (Union[Unset, list[int]]):
        include_deleted (Union[Unset, bool]):
        created_at_min (Union[Unset, datetime.datetime]):
        created_at_max (Union[Unset, datetime.datetime]):
        updated_at_min (Union[Unset, datetime.datetime]):
        updated_at_max (Union[Unset, datetime.datetime]):
        name (Union[Unset, str]):
        email (Union[Unset, str]):
        first_name (Union[Unset, str]):
        last_name (Union[Unset, str]):
        company (Union[Unset, str]):
        phone (Union[Unset, str]):
        category (Union[Unset, str]):
        currency (Union[Unset, str]):
        reference_id (Union[Unset, str]):

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

    kwargs = _get_kwargs(
        limit=limit,
        page=page,
        ids=ids,
        include_deleted=include_deleted,
        created_at_min=created_at_min,
        created_at_max=created_at_max,
        updated_at_min=updated_at_min,
        updated_at_max=updated_at_max,
        name=name,
        email=email,
        first_name=first_name,
        last_name=last_name,
        company=company,
        phone=phone,
        category=category,
        currency=currency,
        reference_id=reference_id,
    )

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

    return _build_response(client=client, response=response)

sync(*, client, limit=50, page=1, ids=UNSET, include_deleted=UNSET, created_at_min=UNSET, created_at_max=UNSET, updated_at_min=UNSET, updated_at_max=UNSET, name=UNSET, email=UNSET, first_name=UNSET, last_name=UNSET, company=UNSET, phone=UNSET, category=UNSET, currency=UNSET, reference_id=UNSET)

List all customers

Returns a list of customers you've previously created.

Parameters:

  • limit (Union[Unset, int], default: 50 ) –

    Default: 50.

  • page (Union[Unset, int], default: 1 ) –

    Default: 1.

  • ids (Union[Unset, list[int]], default: UNSET ) –
  • include_deleted (Union[Unset, bool], default: UNSET ) –
  • created_at_min (Union[Unset, datetime], default: UNSET ) –
  • created_at_max (Union[Unset, datetime], default: UNSET ) –
  • updated_at_min (Union[Unset, datetime], default: UNSET ) –
  • updated_at_max (Union[Unset, datetime], default: UNSET ) –
  • name (Union[Unset, str], default: UNSET ) –
  • email (Union[Unset, str], default: UNSET ) –
  • first_name (Union[Unset, str], default: UNSET ) –
  • last_name (Union[Unset, str], default: UNSET ) –
  • company (Union[Unset, str], default: UNSET ) –
  • phone (Union[Unset, str], default: UNSET ) –
  • category (Union[Unset, str], default: UNSET ) –
  • currency (Union[Unset, str], default: UNSET ) –
  • reference_id (Union[Unset, str], 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/customer/get_all_customers.py 
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
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
280
281
282
283
284
285
286
287
288
289
def sync(
    *,
    client: AuthenticatedClient | Client,
    limit: Unset | int = 50,
    page: Unset | int = 1,
    ids: Unset | list[int] = UNSET,
    include_deleted: Unset | bool = UNSET,
    created_at_min: Unset | datetime.datetime = UNSET,
    created_at_max: Unset | datetime.datetime = UNSET,
    updated_at_min: Unset | datetime.datetime = UNSET,
    updated_at_max: Unset | datetime.datetime = UNSET,
    name: Unset | str = UNSET,
    email: Unset | str = UNSET,
    first_name: Unset | str = UNSET,
    last_name: Unset | str = UNSET,
    company: Unset | str = UNSET,
    phone: Unset | str = UNSET,
    category: Unset | str = UNSET,
    currency: Unset | str = UNSET,
    reference_id: Unset | str = UNSET,
) -> CustomerListResponse | ErrorResponse | None:
    """List all customers

     Returns a list of customers you've previously created.

    Args:
        limit (Union[Unset, int]):  Default: 50.
        page (Union[Unset, int]):  Default: 1.
        ids (Union[Unset, list[int]]):
        include_deleted (Union[Unset, bool]):
        created_at_min (Union[Unset, datetime.datetime]):
        created_at_max (Union[Unset, datetime.datetime]):
        updated_at_min (Union[Unset, datetime.datetime]):
        updated_at_max (Union[Unset, datetime.datetime]):
        name (Union[Unset, str]):
        email (Union[Unset, str]):
        first_name (Union[Unset, str]):
        last_name (Union[Unset, str]):
        company (Union[Unset, str]):
        phone (Union[Unset, str]):
        category (Union[Unset, str]):
        currency (Union[Unset, str]):
        reference_id (Union[Unset, str]):

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

    return sync_detailed(
        client=client,
        limit=limit,
        page=page,
        ids=ids,
        include_deleted=include_deleted,
        created_at_min=created_at_min,
        created_at_max=created_at_max,
        updated_at_min=updated_at_min,
        updated_at_max=updated_at_max,
        name=name,
        email=email,
        first_name=first_name,
        last_name=last_name,
        company=company,
        phone=phone,
        category=category,
        currency=currency,
        reference_id=reference_id,
    ).parsed

sync_detailed(*, client, limit=50, page=1, ids=UNSET, include_deleted=UNSET, created_at_min=UNSET, created_at_max=UNSET, updated_at_min=UNSET, updated_at_max=UNSET, name=UNSET, email=UNSET, first_name=UNSET, last_name=UNSET, company=UNSET, phone=UNSET, category=UNSET, currency=UNSET, reference_id=UNSET)

List all customers

Returns a list of customers you've previously created.

Parameters:

  • limit (Union[Unset, int], default: 50 ) –

    Default: 50.

  • page (Union[Unset, int], default: 1 ) –

    Default: 1.

  • ids (Union[Unset, list[int]], default: UNSET ) –
  • include_deleted (Union[Unset, bool], default: UNSET ) –
  • created_at_min (Union[Unset, datetime], default: UNSET ) –
  • created_at_max (Union[Unset, datetime], default: UNSET ) –
  • updated_at_min (Union[Unset, datetime], default: UNSET ) –
  • updated_at_max (Union[Unset, datetime], default: UNSET ) –
  • name (Union[Unset, str], default: UNSET ) –
  • email (Union[Unset, str], default: UNSET ) –
  • first_name (Union[Unset, str], default: UNSET ) –
  • last_name (Union[Unset, str], default: UNSET ) –
  • company (Union[Unset, str], default: UNSET ) –
  • phone (Union[Unset, str], default: UNSET ) –
  • category (Union[Unset, str], default: UNSET ) –
  • currency (Union[Unset, str], default: UNSET ) –
  • reference_id (Union[Unset, str], 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/customer/get_all_customers.py 
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
169
170
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
def sync_detailed(
    *,
    client: AuthenticatedClient | Client,
    limit: Unset | int = 50,
    page: Unset | int = 1,
    ids: Unset | list[int] = UNSET,
    include_deleted: Unset | bool = UNSET,
    created_at_min: Unset | datetime.datetime = UNSET,
    created_at_max: Unset | datetime.datetime = UNSET,
    updated_at_min: Unset | datetime.datetime = UNSET,
    updated_at_max: Unset | datetime.datetime = UNSET,
    name: Unset | str = UNSET,
    email: Unset | str = UNSET,
    first_name: Unset | str = UNSET,
    last_name: Unset | str = UNSET,
    company: Unset | str = UNSET,
    phone: Unset | str = UNSET,
    category: Unset | str = UNSET,
    currency: Unset | str = UNSET,
    reference_id: Unset | str = UNSET,
) -> Response[CustomerListResponse | ErrorResponse]:
    """List all customers

     Returns a list of customers you've previously created.

    Args:
        limit (Union[Unset, int]):  Default: 50.
        page (Union[Unset, int]):  Default: 1.
        ids (Union[Unset, list[int]]):
        include_deleted (Union[Unset, bool]):
        created_at_min (Union[Unset, datetime.datetime]):
        created_at_max (Union[Unset, datetime.datetime]):
        updated_at_min (Union[Unset, datetime.datetime]):
        updated_at_max (Union[Unset, datetime.datetime]):
        name (Union[Unset, str]):
        email (Union[Unset, str]):
        first_name (Union[Unset, str]):
        last_name (Union[Unset, str]):
        company (Union[Unset, str]):
        phone (Union[Unset, str]):
        category (Union[Unset, str]):
        currency (Union[Unset, str]):
        reference_id (Union[Unset, str]):

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

    kwargs = _get_kwargs(
        limit=limit,
        page=page,
        ids=ids,
        include_deleted=include_deleted,
        created_at_min=created_at_min,
        created_at_max=created_at_max,
        updated_at_min=updated_at_min,
        updated_at_max=updated_at_max,
        name=name,
        email=email,
        first_name=first_name,
        last_name=last_name,
        company=company,
        phone=phone,
        category=category,
        currency=currency,
        reference_id=reference_id,
    )

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

    return _build_response(client=client, response=response)