Interface EnrollmentMutations

Hierarchy

  • EnrollmentMutations

Properties

addEnrollmentPeriod create createFromCheckout delete removeEnrollmentPeriodByOrderId updateBillingAddress updateContact updateContext updateDelivery updatePayment updatePlan updateStatus

Properties

addEnrollmentPeriod

addEnrollmentPeriod: ((enrollmentId: string, period: EnrollmentPeriod, userId?: string) => Promise<Enrollment>)

Type declaration

create

create: ((doc: EnrollmentData, requestContext: Context) => Promise<Enrollment>)

Type declaration

createFromCheckout

createFromCheckout: ((order: Order, params: { context: { deliveryContext?: any; paymentContext?: any }; items: { orderPosition: OrderPosition; product: Product }[] }, requestContext: Context) => Promise<Enrollment[]>)

Type declaration

    • (order: Order, params: { context: { deliveryContext?: any; paymentContext?: any }; items: { orderPosition: OrderPosition; product: Product }[] }, requestContext: Context): Promise<Enrollment[]>

    • Parameters

      • order: Order
      • params: { context: { deliveryContext?: any; paymentContext?: any }; items: { orderPosition: OrderPosition; product: Product }[] }
        • context: { deliveryContext?: any; paymentContext?: any }
          • Optional deliveryContext?: any
          • Optional paymentContext?: any
        • items: { orderPosition: OrderPosition; product: Product }[]
      • requestContext: Context

      Returns Promise<Enrollment[]>

delete

delete: ((enrollmentId: string, userId?: string) => Promise<number>)

Type declaration

    • (enrollmentId: string, userId?: string): Promise<number>

    • Parameters

      • enrollmentId: string
      • Optional userId: string

      Returns Promise<number>

removeEnrollmentPeriodByOrderId

removeEnrollmentPeriodByOrderId: ((enrollmentId: string, orderId: string, userId?: string) => Promise<Enrollment>)

Type declaration

    • (enrollmentId: string, orderId: string, userId?: string): Promise<Enrollment>

    • Parameters

      • enrollmentId: string
      • orderId: string
      • Optional userId: string

      Returns Promise<Enrollment>

updateBillingAddress

updateBillingAddress: ((enrollmentId: string, billingAddress: Address, userId?: string) => Promise<Enrollment>)

Type declaration

    • (enrollmentId: string, billingAddress: Address, userId?: string): Promise<Enrollment>

    • Parameters

      • enrollmentId: string
      • billingAddress: Address
      • Optional userId: string

      Returns Promise<Enrollment>

updateContact

updateContact: ((enrollmentId: string, contact: Contact, userId?: string) => Promise<Enrollment>)

Type declaration

    • (enrollmentId: string, contact: Contact, userId?: string): Promise<Enrollment>

    • Parameters

      • enrollmentId: string
      • contact: Contact
      • Optional userId: string

      Returns Promise<Enrollment>

updateContext

updateContext: ((enrollmentId: string, context: any, userId?: string) => Promise<Enrollment>)

Type declaration

    • (enrollmentId: string, context: any, userId?: string): Promise<Enrollment>

    • Parameters

      • enrollmentId: string
      • context: any
      • Optional userId: string

      Returns Promise<Enrollment>

updateDelivery

updateDelivery: ((enrollmentId: string, delivery: { context?: any; deliveryProviderId?: string }, userId?: string) => Promise<Enrollment>)

Type declaration

    • (enrollmentId: string, delivery: { context?: any; deliveryProviderId?: string }, userId?: string): Promise<Enrollment>

    • Parameters

      • enrollmentId: string
      • delivery: { context?: any; deliveryProviderId?: string }
        • Optional context?: any
        • Optional deliveryProviderId?: string
      • Optional userId: string

      Returns Promise<Enrollment>

updatePayment

updatePayment: ((enrollmentId: string, payment: { context?: any; paymentProviderId?: string }, userId?: string) => Promise<Enrollment>)

Type declaration

    • (enrollmentId: string, payment: { context?: any; paymentProviderId?: string }, userId?: string): Promise<Enrollment>

    • Parameters

      • enrollmentId: string
      • payment: { context?: any; paymentProviderId?: string }
        • Optional context?: any
        • Optional paymentProviderId?: string
      • Optional userId: string

      Returns Promise<Enrollment>

updatePlan

updatePlan: ((enrollmentId: string, plan: EnrollmentPlan, requestContext: Context) => Promise<Enrollment>)

Type declaration

updateStatus

updateStatus: ((enrollmentId: string, params: { info?: string; status: EnrollmentStatus }, requestContext: Context) => Promise<Enrollment>)

Type declaration

Settings

Member Visibility

Theme