Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Company

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional _addresses

_addresses: Address[]

Optional _emailAddresses

_emailAddresses: EmailAddress[]

Optional _paymentPhoneNumbers

_paymentPhoneNumbers: PhoneNumber[]

Optional _phoneNumbers

_phoneNumbers: PhoneNumber[]

Optional _users

_users: UserCompany[]

Optional acceptBankTransfer

acceptBankTransfer: boolean

Optional acceptPaypal

acceptPaypal: boolean

Optional acceptPhonePayment

acceptPhonePayment: boolean

Optional acceptStripe

acceptStripe: boolean

Optional acceptUtrust

acceptUtrust: boolean

Optional addresses

addresses: Address[]

Optional appliedJobs

appliedJobs: Job[]

Optional archived

archived: null | Date

Readonly backObjects

backObjects: Set<Entity> = ...

Optional banks

banks: Bank[]

Optional callToActionDetails

callToActionDetails: any[]

Optional callToActions

callToActions: string

Optional carts

carts: Cart[]

Optional companyInvitations

companyInvitations: CompanyInvitation[]

Optional country

country: string

create

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

Type declaration

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

    • Parameters

      • Optional options: CreateOptions

      Returns Promise<Company>

Optional defaultCurrency

defaultCurrency: string

Optional defaultTaxType

defaultTaxType: null | CountryTax

Optional domains

domains: Domain[]

Optional emailAddresses

emailAddresses: EmailAddress[]

Optional id

id: number

Optional invoicesHas

invoicesHas: Invoice[]

Optional isBlocked

isBlocked: boolean

isDirty

isDirty: boolean = false

Optional isNew

isNew: boolean

Optional isPaypalValid

isPaypalValid: boolean

Optional isStripeValid

isStripeValid: boolean

Optional isUtrustValid

isUtrustValid: boolean

key

key: string = ...

Optional logo

logo: null | MerchiFile

merchi

merchi: Merchi

Optional name

name: string

Optional ownershipUnconfirmed

ownershipUnconfirmed: boolean

Optional paymentPhoneNumbers

paymentPhoneNumbers: PhoneNumber[]

Optional paypalAccount

paypalAccount: null | string

Optional paypalPassword

paypalPassword: null | string

Optional paypalSignature

paypalSignature: null | string

Optional phoneNumbers

phoneNumbers: PhoneNumber[]

propertiesMap

propertiesMap: Map<string, PropertyInfo>

Optional savedProducts

savedProducts: Product[]

Optional shipmentsAsReceiver

shipmentsAsReceiver: Shipment[]

Optional shipmentsAsSender

shipmentsAsSender: Shipment[]

Optional stripeApiKey

stripeApiKey: null | string

Optional stripeCustomerId

stripeCustomerId: string

Optional stripePublishableKey

stripePublishableKey: null | string

Optional subscriptionInvoices

subscriptionInvoices: Invoice[]

Optional subscriptionOutstanding

subscriptionOutstanding: boolean

Optional subscriptionPlan

subscriptionPlan: null | SubscriptionPlan

Optional taxNumber

taxNumber: null | string

Optional taxNumberType

taxNumberType: null | string

Optional taxTypes

taxTypes: CountryTax[]

Optional userCompanies

userCompanies: UserCompany[]

Optional utrustApiKey

utrustApiKey: null | string

Optional utrustWebhookKey

utrustWebhookKey: null | string

Optional website

website: null | string

Static merchi

merchi: Merchi

Methods

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