Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Domain

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional activeTheme

activeTheme: Theme

Optional apiSecret

apiSecret: null | string

Optional archived

archived: null | Date

Readonly backObjects

backObjects: Set<Entity> = ...

Optional callToActionDetails

callToActionDetails: any[]

Optional callToActions

callToActions: string

Optional canSupply

canSupply: Domain[]

Optional carts

carts: Cart[]

Optional categories

categories: Category[]

Optional company

company: Company

Optional conversionTrackingCode

conversionTrackingCode: null | string

create

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

Type declaration

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

    • Parameters

      • Optional options: CreateOptions

      Returns Promise<Domain>

Optional domain

domain: string

Optional domainInvitations

domainInvitations: DomainInvitation[]

Optional domainType

domainType: DomainType

Optional emailDomain

emailDomain: string

Optional enableEmailNotifications

enableEmailNotifications: boolean

Optional enableNotifications

enableNotifications: boolean

Optional enableSmsNotifications

enableSmsNotifications: boolean

Optional enrollments

enrollments: EnrolledDomain[]

Optional favicon

favicon: null | MerchiFile

Optional id

id: number

Optional invoices

invoices: Invoice[]

isDirty

isDirty: boolean = false

Optional isMaster

isMaster: boolean

Optional jobs

jobs: Job[]

Optional jobsAssignees

jobsAssignees: User[]

key

key: string = ...

Optional logo

logo: null | MerchiFile

Optional mailgunRecords

mailgunRecords: any[]

Optional menus

menus: Menu[]

merchi

merchi: Merchi

Optional newConversionTrackingCode

newConversionTrackingCode: null | string

Optional newGlobalTrackingCode

newGlobalTrackingCode: null | string

Optional notifications

notifications: Notification[]

Optional ownedBy

ownedBy: Company

Optional products

products: Product[]

propertiesMap

propertiesMap: Map<string, PropertyInfo>

Optional sessions

sessions: Session[]

Optional showDomainPublicly

showDomainPublicly: boolean

Optional smsName

smsName: string

Optional subDomain

subDomain: string

Optional suppliedBy

suppliedBy: Domain[]

Optional supplyProducts

supplyProducts: SupplyDomain[]

Optional tags

tags: DomainTag[]

Optional themes

themes: Theme[]

Optional webflowApiKey

webflowApiKey: 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>

defaultCurrency

  • defaultCurrency(): string

defaultTaxType

delete

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

fromJson

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

getActiveTheme

  • getActiveTheme(): Theme

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