Class Entity

Hierarchy

Entity
- Address
- Assignment
- Backup
- Bank
- Cart
- CartItem
- CartShipmentGroup
- CartShipmentQuote
- Category
- Company
- CompanyInvitation
- Component
- ComponentTag
- CountryTax
- Discount
- DiscountGroup
- Domain
- DomainInvitation
- DomainTag
- Draft
- DraftComment
- EmailAddress
- EmailCounter
- EnrolledDomain
- ExchangeRate
- MerchiFile
- Inventory
- InventoryUnitVariation
- Invoice
- Item
- Job
- JobComment
- MatchingInventory
- Menu
- MenuItem
- Notification
- Page
- Payment
- PhoneNumber
- Product
- ProductionComment
- Quote
- QuoteItem
- Session
- Shipment
- ShipmentMethod
- ShipmentMethodVariation
- ShortUrl
- SubscriptionPlan
- SupplyDomain
- SystemRole
- Theme
- User
- UserCompany
- Variation
- VariationField
- VariationFieldsOption
- VariationOption
- VariationsGroup

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Entity(merchi?: Merchi): Entity

- Defined in src/entity.ts:281
Parameters
- Optional merchi: Merchi
Returns Entity

Properties

Readonly backObjects

backObjects: Set<Entity> = ...

create

create: (options?: CreateOptions) => Promise<Entity> = ...

Type declaration

- (options?: CreateOptions): Promise<Entity>
- Parameters
  - Optional options: CreateOptions
  Returns Promise<Entity>

isDirty

isDirty: boolean = false

key

key: string = ...

merchi

merchi: Merchi

propertiesMap

propertiesMap: Map<string, PropertyInfo>

Static merchi

merchi: Merchi

Methods

cleanDirty

cleanDirty(): void

- Defined in src/entity.ts:667
Returns void

createFactory

createFactory(__namedParameters: Object): (options?: CreateOptions) => Promise<this>

- Defined in src/entity.ts:623
Parameters
- __namedParameters: Object
Returns (options?: CreateOptions) => Promise<this>
- - (options?: CreateOptions): Promise<this>
  - Parameters
    - Optional options: CreateOptions
    Returns Promise<this>

delete

delete(options?: DeleteOptions): Promise<this>

- Defined in src/entity.ts:916
Parameters
- Optional options: DeleteOptions
Returns Promise<this>

fromJson

fromJson(json: any, options?: FromJsonOptions): this

- Defined in src/entity.ts:687
Parameters
- json: any
- Optional options: FromJsonOptions
Returns this

getPrimaryKeyValue

getPrimaryKeyValue(): any

- Defined in src/entity.ts:290
Returns any

recover

recover(options?: SaveOptions): Promise<this>

- Defined in src/entity.ts:932
Parameters
- Optional options: SaveOptions
Returns Promise<this>

save

save(options?: SaveOptions): Promise<this>

- Defined in src/entity.ts:600
Parameters
- Optional options: SaveOptions
Returns Promise<this>

toFormData

toFormData(options?: SerialiseOptions, fileIndex?: Counter): FormData

- Defined in src/entity.ts:766
Parameters
- Optional options: SerialiseOptions
- Optional fileIndex: Counter
Returns FormData

toJson

toJson(): any

- Defined in src/entity.ts:733
Returns any

updateOrder

updateOrder(property: string): void

- Defined in src/entity.ts:894
Parameters
- property: string
Returns void

Static get

get<T>(key: string | number, options?: GetOptions): Promise<InstanceType<T>>

- Defined in src/entity.ts:352
Type parameters
- T: typeof Entity
Parameters
- key: string | number
- Optional options: GetOptions
Returns Promise<InstanceType<T>>

Static list

list<T>(options?: ListOptions): Promise<ListResponse<InstanceType<T>>>

- Defined in src/entity.ts:376
Type parameters
- T: typeof Entity
Parameters
- Optional options: ListOptions
Returns Promise<ListResponse<InstanceType<T>>>

Generated using TypeDoc