chore(docs): Updated API Reference (automated) (#12826)

Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2025-06-25 12:18:41 +00:00
committed by GitHub
parent 441334abf4
commit 7ac734ca21
168 changed files with 2982 additions and 25 deletions
@@ -671,6 +671,14 @@ get:
items:
type: object
title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
x-codeSamples:
- lang: JavaScript
label: JS SDK
@@ -115,6 +115,14 @@ get:
items:
type: object
title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
x-codeSamples:
- lang: Shell
label: cURL
@@ -132,6 +132,14 @@ get:
type: string
title: q
description: Search term to filter the address's searchable properties.
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
security:
- cookie_auth: []
- jwt_token: []
@@ -133,6 +133,14 @@ get:
- completed
- draft
- archived
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
x-codeSamples:
- lang: JavaScript
label: JS SDK
@@ -79,6 +79,14 @@ get:
type: string
title: region_id
description: Filter by a region ID.
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
x-codeSamples:
- lang: JavaScript
label: JS SDK
@@ -752,6 +752,14 @@ get:
type: string
title: name
description: A product category name.
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
x-codeSamples:
- lang: JavaScript
label: JS SDK
@@ -671,6 +671,14 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
x-codeSamples:
- lang: Shell
label: cURL
@@ -668,6 +668,14 @@ get:
type: boolean
title: $exists
description: Filter by whether a value for this parameter exists (not `null`).
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
x-codeSamples:
- lang: Shell
label: cURL
@@ -148,6 +148,14 @@ get:
items:
type: object
title: $or
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
x-codeSamples:
- lang: JavaScript
label: JS SDK
@@ -65,6 +65,14 @@ get:
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 `-`.
- name: with_deleted
in: query
description: Whether to include deleted records in the result.
required: false
schema:
type: boolean
title: with_deleted
description: Whether to include deleted records in the result.
x-codeSamples:
- lang: Shell
label: cURL