Options
All
  • Public
  • Public/Protected
  • All
Menu

Class API

Hierarchy

  • API

Index

Constructors

Properties

Methods

Constructors

constructor

  • new API(transport: API): API

Properties

Private transport

transport: API

Handles communication with API

Methods

applyCouponCode

  • applyCouponCode(headers: Headers, session: Session, couponCode: String): Promise<AxiosResponse>

  • Applies coupon code to current order

    Parameters

    • headers: Headers

      Request headers

    • session: Session

      Checkout Session

    • couponCode: String

      Coupon Code to apply

    Returns Promise<AxiosResponse>

    A Promise that resolves to an apply coupon result

createAddress

  • Create new shipping address

    Parameters

    Returns Promise<AxiosResponse>

    A Promise that resolves to the newly created shipping address

editAddress

  • editAddress(headers: Headers, session: Session, shippingAddressId: String, addressFormInput: AddressForm): Promise<AxiosResponse>

  • Edit shipping address

    Parameters

    • headers: Headers

      Request headers

    • session: Session

      Checkout Session

    • shippingAddressId: String

      Shipping Address Id

    • addressFormInput: AddressForm

      Address Form Input

    Returns Promise<AxiosResponse>

    A Promise that resolves to the edited shipping address

getAddresses

  • getAddresses(headers: Headers, session: Session): Promise<AxiosResponse>

  • Get all shipping address

    Parameters

    Returns Promise<AxiosResponse>

    A Promise that resolves to all of a logged in customer's shipping addresses

getCurrentOrder

  • getCurrentOrder(headers: Headers, session: Session): Promise<AxiosResponse>

  • Gets current order

    Parameters

    Returns Promise<AxiosResponse>

    A Promise that resolves to an object with product create result

getFormKey

  • getFormKey(headers: Headers): Promise<AxiosResponse>

  • Gets form_key

    Parameters

    Returns Promise<AxiosResponse>

    form_key value as a string

getPayments

  • getPayments(headers: Headers, session: Session): Promise<AxiosResponse>

  • Gets saved payments

    Parameters

    Returns Promise<AxiosResponse>

    A Promise that resolves to an object with product create result

removeCoupon

  • removeCoupon(headers: Headers, session: Session): Promise<AxiosResponse>

  • Removes coupon from current order

    Parameters

    Returns Promise<AxiosResponse>

    A Promise that resolves to an apply coupon result

Generated using TypeDoc