chore(docs): Generated API Reference (#3211)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
9997485c55
commit
14b2de94e2
@@ -2,30 +2,44 @@ title: Customer
|
||||
description: Represents a customer
|
||||
type: object
|
||||
required:
|
||||
- billing_address_id
|
||||
- created_at
|
||||
- deleted_at
|
||||
- email
|
||||
- first_name
|
||||
- has_account
|
||||
- id
|
||||
- last_name
|
||||
- metadata
|
||||
- phone
|
||||
- updated_at
|
||||
properties:
|
||||
id:
|
||||
type: string
|
||||
description: The customer's ID
|
||||
type: string
|
||||
example: cus_01G2SG30J8C85S4A5CHM2S1NS2
|
||||
email:
|
||||
type: string
|
||||
description: The customer's email
|
||||
type: string
|
||||
format: email
|
||||
first_name:
|
||||
type: string
|
||||
description: The customer's first name
|
||||
nullable: true
|
||||
type: string
|
||||
example: Arno
|
||||
last_name:
|
||||
type: string
|
||||
description: The customer's last name
|
||||
nullable: true
|
||||
type: string
|
||||
example: Willms
|
||||
billing_address_id:
|
||||
type: string
|
||||
description: The customer's billing address ID
|
||||
nullable: true
|
||||
type: string
|
||||
example: addr_01G8ZH853YPY9B94857DY91YGW
|
||||
billing_address:
|
||||
description: Available if the relation `billing_address` is expanded.
|
||||
nullable: true
|
||||
$ref: ./Address.yaml
|
||||
shipping_addresses:
|
||||
description: Available if the relation `shipping_addresses` is expanded.
|
||||
@@ -33,19 +47,19 @@ properties:
|
||||
items:
|
||||
$ref: ./Address.yaml
|
||||
phone:
|
||||
type: string
|
||||
description: The customer's phone number
|
||||
nullable: true
|
||||
type: string
|
||||
example: 16128234334802
|
||||
has_account:
|
||||
type: boolean
|
||||
description: Whether the customer has an account or not
|
||||
type: boolean
|
||||
default: false
|
||||
orders:
|
||||
description: Available if the relation `orders` is expanded.
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
description: An order object.
|
||||
groups:
|
||||
description: >-
|
||||
The customer groups the customer belongs to. Available if the relation
|
||||
@@ -54,19 +68,21 @@ properties:
|
||||
items:
|
||||
$ref: ./CustomerGroup.yaml
|
||||
created_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was created.
|
||||
type: string
|
||||
format: date-time
|
||||
updated_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was updated.
|
||||
type: string
|
||||
format: date-time
|
||||
deleted_at:
|
||||
type: string
|
||||
description: The date with timezone at which the resource was deleted.
|
||||
nullable: true
|
||||
type: string
|
||||
format: date-time
|
||||
metadata:
|
||||
type: object
|
||||
description: An optional key-value map with additional details
|
||||
nullable: true
|
||||
type: object
|
||||
example:
|
||||
car: white
|
||||
|
||||
Reference in New Issue
Block a user