@faststore/api 1.8.2 → 1.8.3

package/src/typeDefs/image.graphql

@@ -1,9 +1,27 @@
+"""
+Image.
+"""
 type StoreImage {
+  """
+  Image URL.
+  """
   url: String!
+  """
+  Alias for the image.
+  """
   alternateName: String!
 }
 
+"""
+Image input.
+"""
 input IStoreImage {
+  """
+  Image input URL.
+  """
   url: String!
+  """
+  Alias for the input image.
+  """
   alternateName: String!
 }

package/src/typeDefs/mutation.graphql

@@ -1,18 +1,46 @@
+"""
+Session information.
+"""
 type StoreSession {
+  """
+  Session channel.
+  """
   channel: String
+  """
+  Session country.
+  """
   country: String
+  """
+  Session postal code.
+  """
   postalCode: String
 }
 
+"""
+Session input.
+"""
 input IStoreSession {
+  """
+  Session input channel.
+  """
   channel: String
+  """
+  Session input country.
+  """
   country: String
+  """
+  Session input postal code.
+  """
   postalCode: String
 }
 
 type Mutation {
-  # Returns the order if anything changed with the order. Null if the order is valid
+  """
+  Returns the order if anything has changed in it, or `null` if the order is valid.
+  """
   validateCart(cart: IStoreCart!): StoreCart
-
+  """
+  Update session information.
+  """
   updateSession(session: IStoreSession!): StoreSession!
 }

package/src/typeDefs/offer.graphql

@@ -1,21 +1,71 @@
+"""
+Offer information.
+"""
 type StoreOffer {
+  """
+  This is displayed as the "from" price in the context of promotions' price comparison. This may change before it reaches the shelf.
+  """
   listPrice: Float!
+  """
+  Computed price before applying coupons, taxes or benefits. This may change before it reaches the shelf.
+  """
   sellingPrice: Float!
+  """
+  ISO code of the currency used for the offer prices.
+  """
   priceCurrency: String!
-  # Also known as spotPrice
+  """
+  Also known as spot price.
+  """
   price: Float!
+  """
+  Next date in which price is scheduled to change. If there is no scheduled change, this will be set a year in the future from current time.
+  """
   priceValidUntil: String!
+  """
+  Offer item condition.
+  """
   itemCondition: String!
+  """
+  Offer item availability.
+  """
   availability: String!
+  """
+  Seller responsible for the offer.
+  """
   seller: StoreOrganization!
+  """
+  Information on the item being offered.
+  """
   itemOffered: StoreProduct!
+  """
+  Number of items offered.
+  """
   quantity: Int!
 }
 
+"""
+Offer input.
+"""
 input IStoreOffer {
+  """
+  Also known as spot price.
+  """
   price: Float!
+  """
+  This is displayed as the "from" price in the context of promotions' price comparison. This may change before it reaches the shelf.
+  """
   listPrice: Float!
+  """
+  Seller responsible for the offer.
+  """
   seller: IStoreOrganization!
+  """
+  Information on the item being offered.
+  """
   itemOffered: IStoreProduct!
+  """
+  Number of items offered.
+  """
   quantity: Int!
 }

package/src/typeDefs/order.graphql

@@ -1,9 +1,27 @@
+"""
+Information of a specific order.
+"""
 type StoreOrder {
+  """
+  Order shopping cart ID, also known as `orderFormId`.
+  """
   orderNumber: String!
+  """
+  Array with information on each accepted offer.
+  """
   acceptedOffer: [StoreOffer!]!
 }
 
+"""
+Offer input.
+"""
 input IStoreOrder {
+  """
+  Order shopping cart ID, also known as `orderFormId`.
+  """
   orderNumber: String!
+  """
+  Array with information on each accepted offer.
+  """
   acceptedOffer: [IStoreOffer!]!
 }

package/src/typeDefs/organization.graphql

@@ -1,7 +1,19 @@
+"""
+Organization.
+"""
 type StoreOrganization {
+  """
+  Organization ID.
+  """
   identifier: String!
 }
 
+"""
+Organization input.
+"""
 input IStoreOrganization {
+  """
+  Organization ID.
+  """
   identifier: String!
 }

package/src/typeDefs/pageInfo.graphql

@@ -1,8 +1,25 @@
+"""
+Page information.
+"""
 type StorePageInfo {
+  """
+  Indicates whether next page exists.
+  """
   hasNextPage: Boolean!
+  """
+  Indicates whether previous page exists.
+  """
   hasPreviousPage: Boolean!
+  """
+  Page cursor start.
+  """
   startCursor: String!
+  """
+  Page cursor end.
+  """
   endCursor: String!
-  # Total number of items(products/collections), not pages
+  """
+  Total number of items (products or collections), not pages.
+  """
   totalCount: Int!
 }

package/src/typeDefs/person.graphql

@@ -1,6 +1,21 @@
+"""
+Client profile data.
+"""
 type StorePerson {
+  """
+  Client ID.
+  """
   id: String!
+  """
+  Client email.
+  """
   email: String!
+  """
+  Client first name.
+  """
   givenName: String!
+  """
+  Client last name.
+  """
   familyName: String!
 }

package/src/typeDefs/product.graphql

@@ -1,26 +1,83 @@
+"""
+Product information.
+"""
 type StoreProduct {
-  # Meta tag data
+  """
+  Meta tag data.
+  """
   seo: StoreSeo!
-  # Location for structured data
+  """
+  List of items consisting of chain linked web pages, ending with the current page.
+  """
   breadcrumbList: StoreBreadcrumbList!
-  # Where to retrieve this entity
+  """
+  Corresponding collection URL slug, with which to retrieve this entity.
+  """
   slug: String!
+  """
+  Product name.
+  """
   name: String!
+  """
+  Product ID.
+  """
   productID: String!
+  """
+  Product brand.
+  """
   brand: StoreBrand!
+  """
+  Product description.
+  """
   description: String!
+  """
+  Array of images.
+  """
   image: [StoreImage!]!
+  """
+  Aggregate offer information.
+  """
   offers: StoreAggregateOffer!
+  """
+  Stock Keeping Unit ID.
+  """
   sku: String!
+  """
+  Global Trade Item Number.
+  """
   gtin: String!
+  """
+  Array with review information.
+  """
   review: [StoreReview!]!
+  """
+  Aggregate ratings data.
+  """
   aggregateRating: StoreAggregateRating!
+  """
+  Indicates product group related to this product.
+  """
   isVariantOf: StoreProductGroup!
+  """
+  Array of additional properties.
+  """
   additionalProperty: [StorePropertyValue!]!
 }
 
+"""
+Product input.
+"""
 input IStoreProduct {
+  """
+  Stock Keeping Unit ID.
+  """
   sku: String!
+  """
+  Product name.
+  """
   name: String!
+  """
+  Array of product images.
+  """
   image: [IStoreImage!]!
 }

package/src/typeDefs/productGroup.graphql

@@ -1,6 +1,21 @@
+"""
+Product group information.
+"""
 type StoreProductGroup {
+  """
+  Array of variants related to product group.
+  """
   hasVariant: [StoreProduct!]!
+  """
+  Product group ID.
+  """
   productGroupID: String!
+  """
+  Product group name.
+  """
   name: String!
+  """
+  Array of additional properties.
+  """
   additionalProperty: [StorePropertyValue!]!
 }

package/src/typeDefs/propertyValue.graphql

@@ -1,4 +1,13 @@
+"""
+Properties that can be associated with products and products groups.
+"""
 type StorePropertyValue {
+  """
+  Property value.
+  """
   value: String!
+  """
+  Property name.
+  """
   name: String!
 }

package/src/typeDefs/query.graphql

@@ -1,23 +1,62 @@
+"""
+Product pagination edge.
+"""
 type StoreProductEdge {
+  """
+  Product pagination node.
+  """
   node: StoreProduct!
+  """
+  Product pagination cursor.
+  """
   cursor: String!
 }
 
+"""
+Product connection pagination information.
+"""
 type StoreProductConnection {
+  """
+  Product connection page information.
+  """
   pageInfo: StorePageInfo!
+  """
+  Array with product connection page edges.
+  """
   edges: [StoreProductEdge!]!
 }
 
+"""
+Collection pagination edge.
+"""
 type StoreCollectionEdge {
+  """
+  Collection pagination node.
+  """
   node: StoreCollection!
+  """
+  Collection pagination cursor.
+  """
   cursor: String!
 }
 
+"""
+Collection connection pagination information.
+"""
 type StoreCollectionConnection {
+  """
+  Collection connection page information.
+  """
   pageInfo: StorePageInfo!
+  """
+  Array with collection connection page edges.
+  """
   edges: [StoreCollectionEdge!]!
 }
 
+"""
+Product sorting options used in search.
+"""
 enum StoreSort {
   price_desc
   price_asc
@@ -29,24 +68,51 @@ enum StoreSort {
   score_desc
 }
 
+"""
+Selected facet input.
+"""
 input IStoreSelectedFacet {
   key: String!
   value: String!
 }
 
+"""
+Search facet type.
+"""
 enum StoreFacetType {
   BOOLEAN
   RANGE
 }
 
+"""
+Suggestions information.
+"""
 type StoreSuggestions {
+  """
+  Array with suggestion terms.
+  """
   terms: [String!]
+  """
+  Array with suggestion products' information.
+  """
   products: [StoreProduct!]
 }
 
+"""
+Search result.
+"""
 type StoreSearchResult {
+  """
+  Search result products.
+  """
   products: StoreProductConnection!
+  """
+  Array of search result facets.
+  """
   facets: [StoreFacet!]!
+  """
+  Search result suggestions.
+  """
   suggestions: StoreSuggestions!
 }