chore(docs): Updated API Reference (v2) (#9033)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
20545b194e
commit
cf3c25addf
@@ -4149,12 +4149,12 @@ get:
|
||||
title: $or
|
||||
- name: has_account
|
||||
in: query
|
||||
description: The customer's has account.
|
||||
description: Filter by whether the customer is registered.
|
||||
required: false
|
||||
schema:
|
||||
type: boolean
|
||||
title: has_account
|
||||
description: The customer's has account.
|
||||
description: Filter by whether the customer is registered.
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -4245,35 +4245,6 @@ post:
|
||||
if a field is prefixed with `+` it will be added to the default
|
||||
fields, using `-` will remove it from the default fields. without
|
||||
prefix it will replace the entire default fields.
|
||||
- name: offset
|
||||
in: query
|
||||
description: The number of items to skip when retrieving a list.
|
||||
required: false
|
||||
schema:
|
||||
type: number
|
||||
title: offset
|
||||
description: The number of items to skip when retrieving a list.
|
||||
- name: limit
|
||||
in: query
|
||||
description: Limit the number of items returned in the list.
|
||||
required: false
|
||||
schema:
|
||||
type: number
|
||||
title: limit
|
||||
description: Limit the number of items returned in the list.
|
||||
- name: order
|
||||
in: query
|
||||
description: >-
|
||||
The field to sort the data by. By default, the sort order is ascending.
|
||||
To change the order to descending, prefix the field name with `-`.
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
title: order
|
||||
description: >-
|
||||
The field to sort the data by. By default, the sort order is
|
||||
ascending. To change the order to descending, prefix the field name
|
||||
with `-`.
|
||||
security:
|
||||
- api_token: []
|
||||
- cookie_auth: []
|
||||
@@ -4284,7 +4255,7 @@ post:
|
||||
schema:
|
||||
allOf:
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
description: The customer's details.
|
||||
required:
|
||||
- email
|
||||
- company_name
|
||||
@@ -4318,7 +4289,7 @@ post:
|
||||
type: object
|
||||
description: The customer's metadata.
|
||||
- type: object
|
||||
description: SUMMARY
|
||||
description: The customer's details.
|
||||
properties:
|
||||
additional_data:
|
||||
type: object
|
||||
@@ -4326,7 +4297,7 @@ post:
|
||||
Pass additional custom data to the API route. This data is
|
||||
passed to the underlying workflow under the
|
||||
`additional_data` parameter.
|
||||
description: SUMMARY
|
||||
description: The customer's details.
|
||||
x-codeSamples:
|
||||
- lang: Shell
|
||||
label: cURL
|
||||
|
||||
Reference in New Issue
Block a user