chore(docs): Generated JS Client Reference (#5334)
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
378ca1b36e
commit
daea35fe73
@@ -6,6 +6,58 @@ displayed_sidebar: jsClientSidebar
|
||||
|
||||
[internal](../modules/internal.md).AddressPayload
|
||||
|
||||
**`Schema`**
|
||||
|
||||
AddressPayload
|
||||
type: object
|
||||
description: "Address fields used when creating/updating an address."
|
||||
properties:
|
||||
first_name:
|
||||
description: First name
|
||||
type: string
|
||||
example: Arno
|
||||
last_name:
|
||||
description: Last name
|
||||
type: string
|
||||
example: Willms
|
||||
phone:
|
||||
type: string
|
||||
description: Phone Number
|
||||
example: 16128234334802
|
||||
company:
|
||||
type: string
|
||||
address_1:
|
||||
description: Address line 1
|
||||
type: string
|
||||
example: 14433 Kemmer Court
|
||||
address_2:
|
||||
description: Address line 2
|
||||
type: string
|
||||
example: Suite 369
|
||||
city:
|
||||
description: City
|
||||
type: string
|
||||
example: South Geoffreyview
|
||||
country_code:
|
||||
description: The 2 character ISO code of the country in lower case
|
||||
type: string
|
||||
externalDocs:
|
||||
url: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements
|
||||
description: See a list of codes.
|
||||
example: st
|
||||
province:
|
||||
description: Province
|
||||
type: string
|
||||
example: Kentucky
|
||||
postal_code:
|
||||
description: Postal Code
|
||||
type: string
|
||||
example: 72093
|
||||
metadata:
|
||||
type: object
|
||||
example: {car: "white"}
|
||||
description: An optional key-value map with additional details
|
||||
|
||||
## Hierarchy
|
||||
|
||||
- **`AddressPayload`**
|
||||
@@ -20,7 +72,7 @@ displayed_sidebar: jsClientSidebar
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/common.d.ts:96
|
||||
packages/medusa/dist/types/common.d.ts:160
|
||||
|
||||
___
|
||||
|
||||
@@ -30,7 +82,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/common.d.ts:97
|
||||
packages/medusa/dist/types/common.d.ts:161
|
||||
|
||||
___
|
||||
|
||||
@@ -40,7 +92,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/common.d.ts:98
|
||||
packages/medusa/dist/types/common.d.ts:162
|
||||
|
||||
___
|
||||
|
||||
@@ -50,7 +102,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/common.d.ts:95
|
||||
packages/medusa/dist/types/common.d.ts:159
|
||||
|
||||
___
|
||||
|
||||
@@ -60,7 +112,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/common.d.ts:99
|
||||
packages/medusa/dist/types/common.d.ts:163
|
||||
|
||||
___
|
||||
|
||||
@@ -70,7 +122,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/common.d.ts:91
|
||||
packages/medusa/dist/types/common.d.ts:155
|
||||
|
||||
___
|
||||
|
||||
@@ -80,17 +132,17 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/common.d.ts:92
|
||||
packages/medusa/dist/types/common.d.ts:156
|
||||
|
||||
___
|
||||
|
||||
### metadata
|
||||
|
||||
• `Optional` **metadata**: `Record`<`string`, `unknown`\>
|
||||
• `Optional` **metadata**: [`Record`](../modules/internal.md#record)<`string`, `unknown`\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/common.d.ts:94
|
||||
packages/medusa/dist/types/common.d.ts:158
|
||||
|
||||
___
|
||||
|
||||
@@ -100,7 +152,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/common.d.ts:93
|
||||
packages/medusa/dist/types/common.d.ts:157
|
||||
|
||||
___
|
||||
|
||||
@@ -110,7 +162,7 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/common.d.ts:101
|
||||
packages/medusa/dist/types/common.d.ts:165
|
||||
|
||||
___
|
||||
|
||||
@@ -120,4 +172,4 @@ ___
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/types/common.d.ts:100
|
||||
packages/medusa/dist/types/common.d.ts:164
|
||||
|
||||
Reference in New Issue
Block a user