Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

constructor

Properties

awaitingPaymentSince

awaitingPaymentSince: Maybe<ISODateTimeAsString>

canceledAt

contactPerson

contactPerson: { email: Field<Email> }

Type declaration

createdAt

Optional directionToBasePriceOn

directionToBasePriceOn: DIRECTIONS

do

do: (a: (b: any) => void) => this

Allows to stay within the context of configuring an order. By default it will be a no operation until setInput or setOutput is called.

Type declaration

    • (a: (b: any) => void): this
    • Parameters

      • a: (b: any) => void
          • (b: any): void
          • Parameters

            • b: any

            Returns void

      Returns this

executedAt

input

input: Inputs

messageToSign

messageToSign: MessageToSign | undefined

output

output: Outputs

Optional partnerFee

partnerFee: PartnerFee

paymentDetails

paymentDetails: PaymentDetails | undefined

paymentReceivedAt

paymentReceivedAt: Maybe<ISODateTimeAsString>

Optional priceBreakdown

priceBreakdown: PriceBreakdown

priceGuaranteedUntil

priceGuaranteedUntil: Maybe<ISODateTimeAsString>

reference

reference: OrderReference

status

status: string

Methods

areAllFieldsValid

  • areAllFieldsValid(): boolean

generateObjectForOrderCreation

  • generateObjectForOrderCreation(): Promise<any>
  • Returns Promise<any>

    On resolve, an object (which is intentionally abstracted to be robust against API changes) that will be sent to Bity's /order endpoint. On rejection, the error object.

isSignatureRequired

  • isSignatureRequired(): boolean
  • Returns boolean

setContactEmail

setInput

setOutput

setPartnerFee

setPriceBreakdown

Static fromBookmarkModify

Static toBookmark

Generated using TypeDoc