api

Type Members

1. case class DeleteProduct(clientId: String, siteId: String, productId: String) extends ProductFeederRequest with Product with Serializable

   

   A request to delete the information about a product.

   A request to delete the information about a product.

   clientId

   the identifier of the client

   siteId

   the optional identifier of the site. If set to null the product will be updated at a client level; otherwise it will be updated at the site level.

   productId

   the identifier of the product

2. case class DeleteProductResponse(clientId: String, siteId: String, productId: String) extends ProductFeederResponse with Product with Serializable

   

   The response for an DeleteProduct request.

   The response for an DeleteProduct request.

   clientId

   the identifier of the client

   siteId

   the optional identifier of the site

   productId

   the identifier of the product

3. case class DownloadFeed(clientId: String, siteId: String, uri: URI, mimeType: MimeType) extends ProductFeederRequest with Product with Serializable

   

   A request to download and import information from a product feed file.

   A request to download and import information from a product feed file.

   clientId

   the identifier of the client

   siteId

   the optional identifier of the site. If set to null the product will be deleted at a client level; otherwise it will be deleted at the site level.

   uri

   a URL pointing to the product feed

   mimeType

   the MIME type of the product feed file

4. case class DownloadFeedResponse(productCount: Int, msg: Option[String] = None) extends ProductFeederResponse with Product with Serializable

   

   The response for an DownloadFeed request.

   The response for an DownloadFeed request.

   productCount

   the number of inserted products

   msg

   an optional message describing the success of the operation

5. case class GetProduct(query: ProductQuery) extends ProductFeederRequest with Product with Serializable

   

   A request to retrieve information about a product.

   A request to retrieve information about a product.

   query

   the query definition for the product

6. case class GetProductResponse(productResult: Option[ProductItem]) extends ProductFeederResponse with Product with Serializable

   

   The response for a GetProduct request.

   The response for a GetProduct request.

   productResult

   a product item wrapped a Some if a matching product was found, None otherwise

7. sealed trait MimeType extends AnyRef

   

8. trait ProductFeederClient extends AnyRef

   

   Interface for clients capable of interacting with the Product Feeder module, by fetching, updating or deleting products.

9. sealed trait ProductFeederRequest extends AnyRef

   

   A request to be sent to the Product Feeder module.

10. sealed trait ProductFeederResponse extends AnyRef

    

    A response from the Product Feeder module to a ProductFeederRequest.

11. case class ProductItem(id: String, attributes: Map[String, Any], lastUpdated: DateTime = DateTime.now()) extends Product with Serializable

    

    Represents a product.

    Represents a product.

    id

    its unique id

    attributes

    a map of attributes

    lastUpdated

    a timestamp for when this product was last updated

12. case class ProductQuery(clientId: String, siteId: String, productId: String) extends Product with Serializable

    

    A product query to be sent to the Product Feeder module.

    A product query to be sent to the Product Feeder module.

    clientId

    the id of the client

    siteId

    optinal site id, if none the query will search for the product at a client level

    productId

    the id of the product

13. case class UpdateProduct(clientId: String, siteId: String, product: ProductItem) extends ProductFeederRequest with Product with Serializable

    

    A request to update the information about a product.

    A request to update the information about a product.

    clientId

    the identifier of the client

    siteId

    the optional identifier of the site. If set to null the product will be updated at a client level; if set it will update at both levels.

    product

    the updated product information

14. case class UpdateProductResponse(clientId: String, siteId: String, product: ProductItem) extends ProductFeederResponse with Product with Serializable

    

    The response for an UpdateProduct request.

    The response for an UpdateProduct request.

    clientId

    the identifier of the client

    siteId

    the optional identifier of the site

    product

    the updated product information