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

Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-02-09 09:50:55 +02:00
committed by GitHub
parent 9997485c55
commit 14b2de94e2
952 changed files with 13745 additions and 9192 deletions

View File

@@ -1,48 +1,71 @@
title: Address
description: An address.
type: object
required:
- address_1
- address_2
- city
- company
- country_code
- created_at
- customer_id
- deleted_at
- first_name
- id
- last_name
- metadata
- phone
- postal_code
- province
- updated_at
properties:
id:
type: string
description: ID of the address
example: addr_01G8ZC9VS1XVE149MGH2J7QSSH
customer_id:
type: string
description: ID of the customer this address belongs to
nullable: true
type: string
example: cus_01G2SG30J8C85S4A5CHM2S1NS2
customer:
description: Available if the relation `customer` is expanded.
type: array
items:
type: object
description: A customer object.
nullable: true
type: object
company:
type: string
description: Company name
nullable: true
type: string
example: Acme
first_name:
type: string
description: First name
nullable: true
type: string
example: Arno
last_name:
type: string
description: Last name
nullable: true
type: string
example: Willms
address_1:
type: string
description: Address line 1
nullable: true
type: string
example: 14433 Kemmer Court
address_2:
type: string
description: Address line 2
nullable: true
type: string
example: Suite 369
city:
type: string
description: City
nullable: true
type: string
example: South Geoffreyview
country_code:
type: string
description: The 2 character ISO code of the country in lower case
nullable: true
type: string
externalDocs:
url: >-
https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
@@ -50,18 +73,22 @@ properties:
example: st
country:
description: A country object. Available if the relation `country` is expanded.
type: object
nullable: true
$ref: ./Country.yaml
province:
type: string
description: Province
nullable: true
type: string
example: Kentucky
postal_code:
type: string
description: Postal Code
nullable: true
type: string
example: 72093
phone:
type: string
description: Phone Number
nullable: true
type: string
example: 16128234334802
created_at:
type: string
@@ -72,11 +99,13 @@ properties:
description: The date with timezone at which the resource was updated.
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