Hierarchy

  • Products

Constructors

Properties

routeAddImage: Route = ...
routeCreateProducts: Route = ...
routeDefaultImage: Route = ...
routeDeleteImage: Route = ...
routeListProducts: Route = ...
routeUpdateProducts: Route = ...
routeViewProducts: Route = ...

Methods

  • Create a product object.

    See

    Products List Products - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • data: object

      Data that will be passed in the body of the request.

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

  • Set the default image associated with the product.

    See

    Products Make Default Image - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • product_id: string

      The id of the product.

    • image_id: string

      The id of the image.

    • data: object

      Data that will be passed in the body of the request.

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

  • Delete an image associated with the product.

    See

    Products Delete Image - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • product_id: string

      The id of the product.

    • image_id: string

      The id of the image.

    • data: object

      Data that will be passed in the body of the request.

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

  • List products that are associated with an organizer account.

    See

    Products List Products - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

  • Update a product's information.

    See

    Products Update Products - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • product_id: string

      The id of the product.

    • data: object

      Data that will be passed in the body of the request.

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

  • Add images one at a time through this route.

    See

    Products Add Image - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • product_id: string

      The id of the product.

    • file: any

      Data of file.

    • filename: string

      Name of file.

    • data: AnyObject

      Data that will be passed in the body of the request.

    • Optional query: null | AnyObject

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

  • View the information pertaining to a single product.

    See

    Products View Products - BingeWave

    Returns

    Returns a promise from Axios.

    Parameters

    • product_id: string

      The id of the product.

    • Optional query: null | object

      Data that will be passed in the query string as a parameter.

    • Optional options: null | object

      Further options that can be used to modify the request.

    Returns Promise<any>

Generated using TypeDoc