chore(docs): Generated API Reference (#2100)
Co-authored-by: shahednasser <shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
co-authored by
shahednasser
shahednasser
parent
501bda6aae
commit
605fa625a2
+203
-203
@@ -1351,6 +1351,209 @@ paths:
|
||||
limit:
|
||||
type: integer
|
||||
description: The number of items per page
|
||||
/customers:
|
||||
post:
|
||||
operationId: PostCustomers
|
||||
summary: Create a Customer
|
||||
description: Creates a Customer.
|
||||
x-authenticated: true
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
required:
|
||||
- email
|
||||
- first_name
|
||||
- last_name
|
||||
- password
|
||||
properties:
|
||||
email:
|
||||
type: string
|
||||
description: The customer's email.
|
||||
format: email
|
||||
first_name:
|
||||
type: string
|
||||
description: The customer's first name.
|
||||
last_name:
|
||||
type: string
|
||||
description: The customer's last name.
|
||||
password:
|
||||
type: string
|
||||
description: The customer's password.
|
||||
format: password
|
||||
phone:
|
||||
type: string
|
||||
description: The customer's phone number.
|
||||
metadata:
|
||||
description: >-
|
||||
An optional set of key-value pairs to hold additional
|
||||
information.
|
||||
type: object
|
||||
tags:
|
||||
- Customer
|
||||
responses:
|
||||
'201':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
properties:
|
||||
customer:
|
||||
$ref: '#/components/schemas/customer'
|
||||
get:
|
||||
operationId: GetCustomers
|
||||
summary: List Customers
|
||||
description: Retrieves a list of Customers.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- in: query
|
||||
name: limit
|
||||
description: The number of items to return.
|
||||
schema:
|
||||
type: integer
|
||||
default: 50
|
||||
- in: query
|
||||
name: offset
|
||||
description: The items to skip before result.
|
||||
schema:
|
||||
type: integer
|
||||
default: 0
|
||||
- in: query
|
||||
name: expand
|
||||
description: (Comma separated) Which fields should be expanded in each customer.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: q
|
||||
description: 'a search term to search email, first_name, and last_name.'
|
||||
schema:
|
||||
type: string
|
||||
tags:
|
||||
- Customer
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
properties:
|
||||
customers:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/customer'
|
||||
count:
|
||||
type: integer
|
||||
description: The total number of items available
|
||||
offset:
|
||||
type: integer
|
||||
description: The number of items skipped before these items
|
||||
limit:
|
||||
type: integer
|
||||
description: The number of items per page
|
||||
'/customers/{id}':
|
||||
get:
|
||||
operationId: GetCustomersCustomer
|
||||
summary: Retrieve a Customer
|
||||
description: Retrieves a Customer.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
description: The ID of the Customer.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: expand
|
||||
description: (Comma separated) Which fields should be expanded in the customer.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: fields
|
||||
description: (Comma separated) Which fields should be included in the customer.
|
||||
schema:
|
||||
type: string
|
||||
tags:
|
||||
- Customer
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
properties:
|
||||
customer:
|
||||
$ref: '#/components/schemas/customer'
|
||||
post:
|
||||
operationId: PostCustomersCustomer
|
||||
summary: Update a Customer
|
||||
description: Updates a Customer.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
description: The ID of the Customer.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: expand
|
||||
description: (Comma separated) Which fields should be expanded in each customer.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: fields
|
||||
description: (Comma separated) Which fields should be retrieved in each customer.
|
||||
schema:
|
||||
type: string
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
properties:
|
||||
email:
|
||||
type: string
|
||||
description: The Customer's email.
|
||||
format: email
|
||||
first_name:
|
||||
type: string
|
||||
description: The Customer's first name.
|
||||
last_name:
|
||||
type: string
|
||||
description: The Customer's last name.
|
||||
phone:
|
||||
type: string
|
||||
description: The Customer's phone number.
|
||||
password:
|
||||
type: string
|
||||
description: The Customer's password.
|
||||
format: password
|
||||
groups:
|
||||
type: array
|
||||
items:
|
||||
required:
|
||||
- id
|
||||
properties:
|
||||
id:
|
||||
description: The ID of a customer group
|
||||
type: string
|
||||
description: A list of customer groups to which the customer belongs.
|
||||
metadata:
|
||||
description: >-
|
||||
An optional set of key-value pairs to hold additional
|
||||
information.
|
||||
type: object
|
||||
tags:
|
||||
- Customer
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
properties:
|
||||
customer:
|
||||
$ref: '#/components/schemas/customer'
|
||||
'/discounts/{id}/regions/{region_id}':
|
||||
post:
|
||||
operationId: PostDiscountsDiscountRegionsRegion
|
||||
@@ -2265,209 +2468,6 @@ paths:
|
||||
properties:
|
||||
discount:
|
||||
$ref: '#/components/schemas/discount'
|
||||
/customers:
|
||||
post:
|
||||
operationId: PostCustomers
|
||||
summary: Create a Customer
|
||||
description: Creates a Customer.
|
||||
x-authenticated: true
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
required:
|
||||
- email
|
||||
- first_name
|
||||
- last_name
|
||||
- password
|
||||
properties:
|
||||
email:
|
||||
type: string
|
||||
description: The customer's email.
|
||||
format: email
|
||||
first_name:
|
||||
type: string
|
||||
description: The customer's first name.
|
||||
last_name:
|
||||
type: string
|
||||
description: The customer's last name.
|
||||
password:
|
||||
type: string
|
||||
description: The customer's password.
|
||||
format: password
|
||||
phone:
|
||||
type: string
|
||||
description: The customer's phone number.
|
||||
metadata:
|
||||
description: >-
|
||||
An optional set of key-value pairs to hold additional
|
||||
information.
|
||||
type: object
|
||||
tags:
|
||||
- Customer
|
||||
responses:
|
||||
'201':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
properties:
|
||||
customer:
|
||||
$ref: '#/components/schemas/customer'
|
||||
get:
|
||||
operationId: GetCustomers
|
||||
summary: List Customers
|
||||
description: Retrieves a list of Customers.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- in: query
|
||||
name: limit
|
||||
description: The number of items to return.
|
||||
schema:
|
||||
type: integer
|
||||
default: 50
|
||||
- in: query
|
||||
name: offset
|
||||
description: The items to skip before result.
|
||||
schema:
|
||||
type: integer
|
||||
default: 0
|
||||
- in: query
|
||||
name: expand
|
||||
description: (Comma separated) Which fields should be expanded in each customer.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: q
|
||||
description: 'a search term to search email, first_name, and last_name.'
|
||||
schema:
|
||||
type: string
|
||||
tags:
|
||||
- Customer
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
properties:
|
||||
customers:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/customer'
|
||||
count:
|
||||
type: integer
|
||||
description: The total number of items available
|
||||
offset:
|
||||
type: integer
|
||||
description: The number of items skipped before these items
|
||||
limit:
|
||||
type: integer
|
||||
description: The number of items per page
|
||||
'/customers/{id}':
|
||||
get:
|
||||
operationId: GetCustomersCustomer
|
||||
summary: Retrieve a Customer
|
||||
description: Retrieves a Customer.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
description: The ID of the Customer.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: expand
|
||||
description: (Comma separated) Which fields should be expanded in the customer.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: fields
|
||||
description: (Comma separated) Which fields should be included in the customer.
|
||||
schema:
|
||||
type: string
|
||||
tags:
|
||||
- Customer
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
properties:
|
||||
customer:
|
||||
$ref: '#/components/schemas/customer'
|
||||
post:
|
||||
operationId: PostCustomersCustomer
|
||||
summary: Update a Customer
|
||||
description: Updates a Customer.
|
||||
x-authenticated: true
|
||||
parameters:
|
||||
- in: path
|
||||
name: id
|
||||
required: true
|
||||
description: The ID of the Customer.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: expand
|
||||
description: (Comma separated) Which fields should be expanded in each customer.
|
||||
schema:
|
||||
type: string
|
||||
- in: query
|
||||
name: fields
|
||||
description: (Comma separated) Which fields should be retrieved in each customer.
|
||||
schema:
|
||||
type: string
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
properties:
|
||||
email:
|
||||
type: string
|
||||
description: The Customer's email.
|
||||
format: email
|
||||
first_name:
|
||||
type: string
|
||||
description: The Customer's first name.
|
||||
last_name:
|
||||
type: string
|
||||
description: The Customer's last name.
|
||||
phone:
|
||||
type: string
|
||||
description: The Customer's phone number.
|
||||
password:
|
||||
type: string
|
||||
description: The Customer's password.
|
||||
format: password
|
||||
groups:
|
||||
type: array
|
||||
items:
|
||||
required:
|
||||
- id
|
||||
properties:
|
||||
id:
|
||||
description: The ID of a customer group
|
||||
type: string
|
||||
description: A list of customer groups to which the customer belongs.
|
||||
metadata:
|
||||
description: >-
|
||||
An optional set of key-value pairs to hold additional
|
||||
information.
|
||||
type: object
|
||||
tags:
|
||||
- Customer
|
||||
responses:
|
||||
'200':
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
properties:
|
||||
customer:
|
||||
$ref: '#/components/schemas/customer'
|
||||
/draft-orders:
|
||||
post:
|
||||
operationId: PostDraftOrders
|
||||
|
||||
Reference in New Issue
Block a user