@faststore/api 1.9.7 → 1.9.8

package/src/__generated__/schema.ts

@@ -19,9 +19,9 @@ export type IStoreCart = {
 };
 
 export type IStoreCurrency = {
-  /** Currency code, e.g: USD */
+  /** Currency code (e.g: USD). */
   code: Scalars['String'];
-  /** Currency symbol, e.g: $ */
+  /** Currency symbol (e.g: $). */
   symbol: Scalars['String'];
 };
 
@@ -47,7 +47,7 @@ export type IStoreOffer = {
   seller: IStoreOrganization;
 };
 
-/** Offer input. */
+/** Order input. */
 export type IStoreOrder = {
   /** Array with information on each accepted offer. */
   acceptedOffer: Array<IStoreOffer>;
@@ -96,9 +96,11 @@ export type IStorePropertyValue = {
   valueReference: Scalars['String'];
 };
 
-/** Selected facet input. */
+/** Selected search facet input. */
 export type IStoreSelectedFacet = {
+  /** Selected search facet key. */
   key: Scalars['String'];
+  /** Selected search facet value. */
   value: Scalars['String'];
 };
 
@@ -120,9 +122,9 @@ export type IStoreSession = {
 
 export type Mutation = {
   __typename?: 'Mutation';
-  /** Returns the order if anything has changed in it, or `null` if the order is valid. */
+  /** Checks for changes between the cart presented in the UI and the cart stored in the ecommerce platform. If changes are detected, it returns the cart stored on the platform. Otherwise, it returns `null`. */
   validateCart?: Maybe<StoreCart>;
-  /** Validate session information. */
+  /** Updates a web session with the specified values. */
   validateSession?: Maybe<StoreSession>;
 };
 
@@ -139,15 +141,15 @@ export type MutationValidateSessionArgs = {
 
 export type Query = {
   __typename?: 'Query';
-  /** All collections query. */
+  /** Returns information about all collections. */
   allCollections: StoreCollectionConnection;
-  /** All products query. */
+  /** Returns information about all products. */
   allProducts: StoreProductConnection;
-  /** Collection query. */
+  /** Returns the details of a collection based on the collection slug. */
   collection: StoreCollection;
-  /** Product query. */
+  /** Returns the details of a product based on the specified locator. */
   product: StoreProduct;
-  /** Search query. */
+  /** Returns the result of a product, facet, or suggestion search. */
   search: StoreSearchResult;
 };
 
@@ -241,7 +243,7 @@ export type StoreCart = {
 /** Shopping cart message. */
 export type StoreCartMessage = {
   __typename?: 'StoreCartMessage';
-  /** Shopping cart message status, which can be `INFO`, `WARNING` OR `ERROR`. */
+  /** Shopping cart message status, which can be `INFO`, `WARNING` or `ERROR`. */
   status: StoreStatus;
   /** Shopping cart message text. */
   text: Scalars['String'];
@@ -264,21 +266,21 @@ export type StoreCollection = {
   type: StoreCollectionType;
 };
 
-/** Collection connection pagination information. */
+/** Collection connections, including pagination information and collections returned by the query. */
 export type StoreCollectionConnection = {
   __typename?: 'StoreCollectionConnection';
-  /** Array with collection connection page edges. */
+  /** Array with collection connection page edges, each containing a collection and a corresponding cursor.. */
   edges: Array<StoreCollectionEdge>;
-  /** Collection connection page information. */
+  /** Collection pagination information. */
   pageInfo: StorePageInfo;
 };
 
-/** Collection pagination edge. */
+/** Each collection edge contains a `node`, with product collection information, and a `cursor`, that can be used as a reference for pagination. */
 export type StoreCollectionEdge = {
   __typename?: 'StoreCollectionEdge';
-  /** Collection pagination cursor. */
+  /** Collection cursor. Used as pagination reference. */
   cursor: Scalars['String'];
-  /** Collection pagination node. */
+  /** Each collection node contains the information of a product collection returned by the query. */
   node: StoreCollection;
 };
 
@@ -300,18 +302,22 @@ export type StoreCollectionMeta = {
 
 /** Product collection type. Possible values are `Department`, `Category`, `Brand` or `Cluster`. */
 export const enum StoreCollectionType {
+  /** Product brand. */
   Brand = 'Brand',
+  /** Second level of product categorization. */
   Category = 'Category',
+  /** Product cluster. */
   Cluster = 'Cluster',
+  /** First level of product categorization. */
   Department = 'Department'
 };
 
 /** Currency information. */
 export type StoreCurrency = {
   __typename?: 'StoreCurrency';
-  /** Currency code, e.g: USD */
+  /** Currency code (e.g: USD). */
   code: Scalars['String'];
-  /** Currency symbol, e.g: $ */
+  /** Currency symbol (e.g: $). */
   symbol: Scalars['String'];
 };
 
@@ -330,7 +336,9 @@ export type StoreFacet = {
 
 /** Search facet type. */
 export const enum StoreFacetType {
+  /** Indicates boolean search facet. */
   Boolean = 'BOOLEAN',
+  /** Indicates range type search facet. */
   Range = 'RANGE'
 };
 
@@ -408,16 +416,16 @@ export type StoreOrganization = {
   identifier: Scalars['String'];
 };
 
-/** Page information. */
+/** Whenever you make a query that allows for pagination, such as `allProducts` or `allCollections`, you can check `StorePageInfo` to learn more about the complete set of items and use it to paginate your queries. */
 export type StorePageInfo = {
   __typename?: 'StorePageInfo';
-  /** Page cursor end. */
+  /** Cursor corresponding to the last possible item. */
   endCursor: Scalars['String'];
-  /** Indicates whether next page exists. */
+  /** Indicates whether there is at least one more page with items after the ones returned in the current query. */
   hasNextPage: Scalars['Boolean'];
-  /** Indicates whether previous page exists. */
+  /** Indicates whether there is at least one more page with items before the ones returned in the current query. */
   hasPreviousPage: Scalars['Boolean'];
-  /** Page cursor start. */
+  /** Cursor corresponding to the first possible item. */
   startCursor: Scalars['String'];
   /** Total number of items (products or collections), not pages. */
   totalCount: Scalars['Int'];
@@ -471,21 +479,21 @@ export type StoreProduct = {
   slug: Scalars['String'];
 };
 
-/** Product connection pagination information. */
+/** Product connections, including pagination information and products returned by the query. */
 export type StoreProductConnection = {
   __typename?: 'StoreProductConnection';
-  /** Array with product connection page edges. */
+  /** Array with product connection edges, each containing a product and a corresponding cursor. */
   edges: Array<StoreProductEdge>;
-  /** Product connection page information. */
+  /** Product pagination information. */
   pageInfo: StorePageInfo;
 };
 
-/** Product pagination edge. */
+/** Each product edge contains a `node`, with product information, and a `cursor`, that can be used as a reference for pagination. */
 export type StoreProductEdge = {
   __typename?: 'StoreProductEdge';
-  /** Product pagination cursor. */
+  /** Product cursor. Used as pagination reference. */
   cursor: Scalars['String'];
-  /** Product pagination node. */
+  /** Each product node contains the information of a product returned by the query. */
   node: StoreProduct;
 };
 
@@ -574,19 +582,27 @@ export type StoreSession = {
   postalCode?: Maybe<Scalars['String']>;
 };
 
-/** Product sorting options used in search. */
+/** Product search results sorting options. */
 export const enum StoreSort {
+  /** Sort by discount value, from highest to lowest. */
   DiscountDesc = 'discount_desc',
+  /** Sort by name, in alphabetical order. */
   NameAsc = 'name_asc',
+  /** Sort by name, in reverse alphabetical order. */
   NameDesc = 'name_desc',
+  /** Sort by orders, from highest to lowest. */
   OrdersDesc = 'orders_desc',
+  /** Sort by price, from lowest to highest. */
   PriceAsc = 'price_asc',
+  /** Sort by price, from highest to lowest. */
   PriceDesc = 'price_desc',
+  /** Sort by release date, from  highest to lowest. */
   ReleaseDesc = 'release_desc',
+  /** Sort by product score, from highest to lowest. */
   ScoreDesc = 'score_desc'
 };
 
-/** Status used to indicate type of message. For instance, in shopping cart messages. */
+/** Status used to indicate a message type. For instance, a shopping cart informative or error message. */
 export const enum StoreStatus {
   Error = 'ERROR',
   Info = 'INFO',

package/src/typeDefs/cart.graphql

@@ -7,7 +7,7 @@ type StoreCartMessage {
   """
   text: String!
   """
-  Shopping cart message status, which can be `INFO`, `WARNING` OR `ERROR`.
+  Shopping cart message status, which can be `INFO`, `WARNING` or `ERROR`.
   """
   status: StoreStatus!
 }

package/src/typeDefs/collection.graphql

@@ -2,9 +2,21 @@
 Product collection type. Possible values are `Department`, `Category`, `Brand` or `Cluster`.
 """
 enum StoreCollectionType {
+  """
+  First level of product categorization.
+  """
   Department
+  """
+  Second level of product categorization.
+  """
   Category
+  """
+  Product brand.
+  """
   Brand
+  """
+  Product cluster.
+  """
   Cluster
 }
 

package/src/typeDefs/mutation.graphql

@@ -1,10 +1,10 @@
 type Mutation {
   """
-  Returns the order if anything has changed in it, or `null` if the order is valid.
+  Checks for changes between the cart presented in the UI and the cart stored in the ecommerce platform. If changes are detected, it returns the cart stored on the platform. Otherwise, it returns `null`.
   """
   validateCart(cart: IStoreCart!): StoreCart
   """
-  Validate session information.
+  Updates a web session with the specified values.
   """
   validateSession(session: IStoreSession!, search: String!): StoreSession
 }

package/src/typeDefs/order.graphql

@@ -13,7 +13,7 @@ type StoreOrder {
 }
 
 """
-Offer input.
+Order input.
 """
 input IStoreOrder {
   """

package/src/typeDefs/pageInfo.graphql

@@ -1,21 +1,21 @@
 """
-Page information.
+Whenever you make a query that allows for pagination, such as `allProducts` or `allCollections`, you can check `StorePageInfo` to learn more about the complete set of items and use it to paginate your queries.
 """
 type StorePageInfo {
   """
-  Indicates whether next page exists.
+  Indicates whether there is at least one more page with items after the ones returned in the current query.
   """
   hasNextPage: Boolean!
   """
-  Indicates whether previous page exists.
+  Indicates whether there is at least one more page with items before the ones returned in the current query.
   """
   hasPreviousPage: Boolean!
   """
-  Page cursor start.
+  Cursor corresponding to the first possible item.
   """
   startCursor: String!
   """
-  Page cursor end.
+  Cursor corresponding to the last possible item.
   """
   endCursor: String!
   """

package/src/typeDefs/query.graphql

@@ -1,78 +1,108 @@
 """
-Product pagination edge.
+Each product edge contains a `node`, with product information, and a `cursor`, that can be used as a reference for pagination.
 """
 type StoreProductEdge {
   """
-  Product pagination node.
+  Each product node contains the information of a product returned by the query.
   """
   node: StoreProduct!
   """
-  Product pagination cursor.
+  Product cursor. Used as pagination reference.
   """
   cursor: String!
 }
 
 """
-Product connection pagination information.
+Product connections, including pagination information and products returned by the query.
 """
 type StoreProductConnection {
   """
-  Product connection page information.
+  Product pagination information.
   """
   pageInfo: StorePageInfo!
   """
-  Array with product connection page edges.
+  Array with product connection edges, each containing a product and a corresponding cursor.
   """
   edges: [StoreProductEdge!]!
 }
 
 """
-Collection pagination edge.
+Each collection edge contains a `node`, with product collection information, and a `cursor`, that can be used as a reference for pagination.
 """
 type StoreCollectionEdge {
   """
-  Collection pagination node.
+  Each collection node contains the information of a product collection returned by the query.
   """
   node: StoreCollection!
   """
-  Collection pagination cursor.
+  Collection cursor. Used as pagination reference.
   """
   cursor: String!
 }
 
 """
-Collection connection pagination information.
+Collection connections, including pagination information and collections returned by the query.
 """
 type StoreCollectionConnection {
   """
-  Collection connection page information.
+  Collection pagination information.
   """
   pageInfo: StorePageInfo!
   """
-  Array with collection connection page edges.
+  Array with collection connection page edges, each containing a collection and a corresponding cursor..
   """
   edges: [StoreCollectionEdge!]!
 }
 
 """
-Product sorting options used in search.
+Product search results sorting options.
 """
 enum StoreSort {
+  """
+  Sort by price, from highest to lowest.
+  """
   price_desc
+  """
+  Sort by price, from lowest to highest.
+  """
   price_asc
+  """
+  Sort by orders, from highest to lowest.
+  """
   orders_desc
+  """
+  Sort by name, in reverse alphabetical order.
+  """
   name_desc
+  """
+  Sort by name, in alphabetical order.
+  """
   name_asc
+  """
+  Sort by release date, from  highest to lowest.
+  """
   release_desc
+  """
+  Sort by discount value, from highest to lowest.
+  """
   discount_desc
+  """
+  Sort by product score, from highest to lowest.
+  """
   score_desc
 }
 
 """
-Selected facet input.
+Selected search facet input.
 """
 input IStoreSelectedFacet {
+  """
+  Selected search facet key.
+  """
   key: String!
+  """
+  Selected search facet value.
+  """
   value: String!
 }
 
@@ -80,7 +110,13 @@ input IStoreSelectedFacet {
 Search facet type.
 """
 enum StoreFacetType {
+  """
+  Indicates boolean search facet.
+  """
   BOOLEAN
+  """
+  Indicates range type search facet.
+  """
   RANGE
 }
 
@@ -132,17 +168,17 @@ type StoreSearchResult {
 
 type Query {
   """
-  Product query.
+  Returns the details of a product based on the specified locator.
   """
   product(
     """
-    Product query locator, which receives an array of selected search facets.
+    An array of selected search facets.
     """
     locator: [IStoreSelectedFacet!]!
   ): StoreProduct!
 
   """
-  Collection query.
+  Returns the details of a collection based on the collection slug.
   """
   collection(
     """
@@ -152,7 +188,7 @@ type Query {
   ): StoreCollection!
 
   """
-  Search query.
+  Returns the result of a product, facet, or suggestion search.
   """
   search(
     """
@@ -160,7 +196,7 @@ type Query {
     """
     first: Int!
     """
-    Search pagination argument, indicating the item after which the results should be fetched.
+    Search pagination argument, indicating the cursor corresponding with the item after which the results should be fetched.
     """
     after: String
     """
@@ -178,7 +214,7 @@ type Query {
   ): StoreSearchResult!
 
   """
-  All products query.
+  Returns information about all products.
   """
   allProducts(
     """
@@ -186,13 +222,13 @@ type Query {
     """
     first: Int!,
     """
-    Product pagination argument, indicating the item after which the items should be fetched.
+    Product pagination argument, indicating the cursor corresponding with the item after which the items should be fetched.
     """
     after: String
   ): StoreProductConnection!
 
   """
-  All collections query.
+  Returns information about all collections.
   """
   allCollections(
     """
@@ -200,7 +236,7 @@ type Query {
     """
     first: Int!,
     """
-    Collection pagination argument, indicating the item after which the items should be fetched.
+    Collection pagination argument, indicating the cursor corresponding with the item after which the items should be fetched.
     """
     after: String
   ): StoreCollectionConnection!

package/src/typeDefs/session.graphql

@@ -3,22 +3,22 @@ Currency information.
 """
 type StoreCurrency {
   """
-  Currency code, e.g: USD
+  Currency code (e.g: USD).
   """
   code: String!
   """
-  Currency symbol, e.g: $
+  Currency symbol (e.g: $).
   """
   symbol: String!
 }
 
 input IStoreCurrency {
   """
-  Currency code, e.g: USD
+  Currency code (e.g: USD).
   """
   code: String!
   """
-  Currency symbol, e.g: $
+  Currency symbol (e.g: $).
   """
   symbol: String!
 }

package/src/typeDefs/status.graphql

@@ -1,5 +1,5 @@
 """
-Status used to indicate type of message. For instance, in shopping cart messages.
+Status used to indicate a message type. For instance, a shopping cart informative or error message.
 """
 enum StoreStatus {
   INFO