Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Shipment

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional archived

archived: null | Date

Optional assignments

assignments: Assignment[]

Readonly backObjects

backObjects: Set<Entity> = ...

Optional buyCost

buyCost: null | number

Optional buyCurrency

buyCurrency: null | string

Optional cost

cost: null | number

create

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

Type declaration

    • (options?: CreateOptions): Promise<Shipment>

    • Parameters

      • Optional options: CreateOptions

      Returns Promise<Shipment>

Optional creationDate

creationDate: null | Date

Optional dispatchDate

dispatchDate: null | Date

Optional dispatchedDate

dispatchedDate: null | Date

Optional expectedReceiveDate

expectedReceiveDate: null | Date

Optional id

id: number

Optional invoices

invoices: Invoice[]

isDirty

isDirty: boolean = false

Optional isOnBehalfOf

isOnBehalfOf: boolean

Optional jobs

jobs: Job[]

key

key: string = ...

Optional maxVolume

maxVolume: null | number

Optional maxWeight

maxWeight: null | number

merchi

merchi: Merchi

Optional onBehalfOf

onBehalfOf: null | User

Optional onBehalfOfCompany

onBehalfOfCompany: null | Company

propertiesMap

propertiesMap: Map<string, PropertyInfo>

Optional quote

quote: null | Quote

Optional receivedDate

receivedDate: null | Date

Optional receiver

receiver: null | User

Optional receiverAddress

receiverAddress: null | Address

Optional receiverCompany

receiverCompany: null | Company

Optional receiverNotes

receiverNotes: null | string

Optional sendEmail

sendEmail: boolean

Optional sendSms

sendSms: boolean

Optional sender

sender: null | User

Optional senderAddress

senderAddress: null | Address

Optional senderCompany

senderCompany: null | Company

Optional senderNotes

senderNotes: null | string

Optional senderResponsible

senderResponsible: boolean

Optional shipmentMethod

shipmentMethod: null | ShipmentMethod

Optional tags

tags: DomainTag[]

Optional taxAmount

taxAmount: null | number

Optional taxType

taxType: null | CountryTax

Optional trackingNumber

trackingNumber: null | string

Optional transportCompany

transportCompany: null | number

Static merchi

merchi: Merchi

Methods

calculateSubTotal

  • calculateSubTotal(options?: CalculateOptions): string

calculateTaxAmount

  • calculateTaxAmount(options?: CalculateOptions): string

calculateTotal

  • calculateTotal(options?: CalculateOptions): string

cleanDirty

  • cleanDirty(): void

createFactory

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

  • 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>

fromJson

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

getPrimaryKeyValue

  • getPrimaryKeyValue(): any

recover

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

save

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

toFormData

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

toJson

  • toJson(): any

updateOrder

  • updateOrder(property: string): void

Static get

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

  • Type parameters

    Parameters

    • key: string | number
    • Optional options: GetOptions

    Returns Promise<InstanceType<T>>

Static list

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

Generated using TypeDoc