chore(docs): Generated API Reference (#6755)

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2024-03-27 18:24:22 +01:00
committed by GitHub
parent 9766266b97
commit 8e3e49fbbf
14 changed files with 934 additions and 81 deletions

View File

@@ -22,7 +22,14 @@ get:
name: expand
description: >-
Comma-separated relations that should be expanded in the returned
customer.
customers.
schema:
type: string
- in: query
name: fields
description: >-
Comma-separated fields that should be included in the returned
customers.
schema:
type: string
- in: query
@@ -30,6 +37,16 @@ get:
description: term to search customers' email, first_name, and last_name fields.
schema:
type: string
- in: query
name: has_account
description: Filter customers by whether they have an account.
schema:
type: boolean
- in: query
name: order
description: A field to sort-order the retrieved customers by.
schema:
type: string
- in: query
name: groups
style: form
@@ -39,6 +56,50 @@ get:
type: array
items:
type: string
- in: query
name: created_at
description: Filter by a creation date range.
schema:
type: object
properties:
lt:
type: string
description: filter by dates less than this date
format: date
gt:
type: string
description: filter by dates greater than this date
format: date
lte:
type: string
description: filter by dates less than or equal to this date
format: date
gte:
type: string
description: filter by dates greater than or equal to this date
format: date
- in: query
name: updated_at
description: Filter by an update date range.
schema:
type: object
properties:
lt:
type: string
description: filter by dates less than this date
format: date
gt:
type: string
description: filter by dates greater than this date
format: date
lte:
type: string
description: filter by dates less than or equal to this date
format: date
gte:
type: string
description: filter by dates greater than or equal to this date
format: date
x-codegen:
method: list
queryParams: AdminGetCustomersParams