232 lines
4.2 KiB
Markdown
232 lines
4.2 KiB
Markdown
---
|
|
displayed_sidebar: entitiesSidebar
|
|
---
|
|
|
|
# Class: Address
|
|
|
|
## Hierarchy
|
|
|
|
- `SoftDeletableEntity`
|
|
|
|
↳ **`Address`**
|
|
|
|
## Constructors
|
|
|
|
### constructor
|
|
|
|
• **new Address**()
|
|
|
|
#### Inherited from
|
|
|
|
SoftDeletableEntity.constructor
|
|
|
|
## Properties
|
|
|
|
### address\_1
|
|
|
|
• **address\_1**: ``null`` \| `string`
|
|
|
|
#### Defined in
|
|
|
|
[models/address.ts:120](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/models/address.ts#L120)
|
|
|
|
___
|
|
|
|
### address\_2
|
|
|
|
• **address\_2**: ``null`` \| `string`
|
|
|
|
#### Defined in
|
|
|
|
[models/address.ts:123](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/models/address.ts#L123)
|
|
|
|
___
|
|
|
|
### city
|
|
|
|
• **city**: ``null`` \| `string`
|
|
|
|
#### Defined in
|
|
|
|
[models/address.ts:126](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/models/address.ts#L126)
|
|
|
|
___
|
|
|
|
### company
|
|
|
|
• **company**: ``null`` \| `string`
|
|
|
|
#### Defined in
|
|
|
|
[models/address.ts:111](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/models/address.ts#L111)
|
|
|
|
___
|
|
|
|
### country
|
|
|
|
• **country**: ``null`` \| [`Country`](Country.md)
|
|
|
|
#### Defined in
|
|
|
|
[models/address.ts:133](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/models/address.ts#L133)
|
|
|
|
___
|
|
|
|
### country\_code
|
|
|
|
• **country\_code**: ``null`` \| `string`
|
|
|
|
#### Defined in
|
|
|
|
[models/address.ts:129](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/models/address.ts#L129)
|
|
|
|
___
|
|
|
|
### created\_at
|
|
|
|
• **created\_at**: `Date`
|
|
|
|
#### Inherited from
|
|
|
|
SoftDeletableEntity.created\_at
|
|
|
|
#### Defined in
|
|
|
|
[interfaces/models/base-entity.ts:16](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/interfaces/models/base-entity.ts#L16)
|
|
|
|
___
|
|
|
|
### customer
|
|
|
|
• **customer**: ``null`` \| [`Customer`](Customer.md)
|
|
|
|
#### Defined in
|
|
|
|
[models/address.ts:108](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/models/address.ts#L108)
|
|
|
|
___
|
|
|
|
### customer\_id
|
|
|
|
• **customer\_id**: ``null`` \| `string`
|
|
|
|
#### Defined in
|
|
|
|
[models/address.ts:104](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/models/address.ts#L104)
|
|
|
|
___
|
|
|
|
### deleted\_at
|
|
|
|
• **deleted\_at**: ``null`` \| `Date`
|
|
|
|
#### Inherited from
|
|
|
|
SoftDeletableEntity.deleted\_at
|
|
|
|
#### Defined in
|
|
|
|
[interfaces/models/soft-deletable-entity.ts:7](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/interfaces/models/soft-deletable-entity.ts#L7)
|
|
|
|
___
|
|
|
|
### first\_name
|
|
|
|
• **first\_name**: ``null`` \| `string`
|
|
|
|
#### Defined in
|
|
|
|
[models/address.ts:114](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/models/address.ts#L114)
|
|
|
|
___
|
|
|
|
### id
|
|
|
|
• **id**: `string`
|
|
|
|
#### Inherited from
|
|
|
|
SoftDeletableEntity.id
|
|
|
|
#### Defined in
|
|
|
|
[interfaces/models/base-entity.ts:13](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/interfaces/models/base-entity.ts#L13)
|
|
|
|
___
|
|
|
|
### last\_name
|
|
|
|
• **last\_name**: ``null`` \| `string`
|
|
|
|
#### Defined in
|
|
|
|
[models/address.ts:117](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/models/address.ts#L117)
|
|
|
|
___
|
|
|
|
### metadata
|
|
|
|
• **metadata**: `Record`<`string`, `unknown`\>
|
|
|
|
#### Defined in
|
|
|
|
[models/address.ts:145](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/models/address.ts#L145)
|
|
|
|
___
|
|
|
|
### phone
|
|
|
|
• **phone**: ``null`` \| `string`
|
|
|
|
#### Defined in
|
|
|
|
[models/address.ts:142](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/models/address.ts#L142)
|
|
|
|
___
|
|
|
|
### postal\_code
|
|
|
|
• **postal\_code**: ``null`` \| `string`
|
|
|
|
#### Defined in
|
|
|
|
[models/address.ts:139](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/models/address.ts#L139)
|
|
|
|
___
|
|
|
|
### province
|
|
|
|
• **province**: ``null`` \| `string`
|
|
|
|
#### Defined in
|
|
|
|
[models/address.ts:136](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/models/address.ts#L136)
|
|
|
|
___
|
|
|
|
### updated\_at
|
|
|
|
• **updated\_at**: `Date`
|
|
|
|
#### Inherited from
|
|
|
|
SoftDeletableEntity.updated\_at
|
|
|
|
#### Defined in
|
|
|
|
[interfaces/models/base-entity.ts:19](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/interfaces/models/base-entity.ts#L19)
|
|
|
|
## Methods
|
|
|
|
### beforeInsert
|
|
|
|
▸ `Private` **beforeInsert**(): `void`
|
|
|
|
#### Returns
|
|
|
|
`void`
|
|
|
|
#### Defined in
|
|
|
|
[models/address.ts:147](https://github.com/medusajs/medusa/blob/70139d0bb/packages/medusa/src/models/address.ts#L147)
|