@faststore/api 1.8.1 → 1.8.4

package/CHANGELOG.md

@@ -3,6 +3,33 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## 1.8.4 (2022-05-10)
+
+**Note:** Version bump only for package @faststore/api
+
+
+
+
+
+## [1.8.3](https://github.com/vtex/faststore/compare/v1.8.2...v1.8.3) (2022-05-10)
+
+
+### Bug Fixes
+
+* Offer availability ([#1282](https://github.com/vtex/faststore/issues/1282)) ([e91aa26](https://github.com/vtex/faststore/commit/e91aa26241c52c926d505b733f2127a809dd3f24))
+
+
+
+
+
+## 1.8.2 (2022-05-09)
+
+**Note:** Version bump only for package @faststore/api
+
+
+
+
+
 ## 1.8.1 (2022-05-09)
 
 **Note:** Version bump only for package @faststore/api

package/dist/__generated__/schema.d.ts

@@ -18,44 +18,71 @@ export declare type Scalars = {
     Int: number;
     Float: number;
 };
+/** Shopping cart identification input. */
 export declare type IStoreCart = {
+    /** Order information, including `orderNumber` and `acceptedOffer`. */
     order: IStoreOrder;
 };
+/** Image input. */
 export declare type IStoreImage = {
+    /** Alias for the input image. */
     alternateName: Scalars['String'];
+    /** Image input URL. */
     url: Scalars['String'];
 };
+/** Offer input. */
 export declare type IStoreOffer = {
+    /** Information on the item being offered. */
     itemOffered: IStoreProduct;
+    /** This is displayed as the "from" price in the context of promotions' price comparison. This may change before it reaches the shelf. */
     listPrice: Scalars['Float'];
+    /** Also known as spot price. */
     price: Scalars['Float'];
+    /** Number of items offered. */
     quantity: Scalars['Int'];
+    /** Seller responsible for the offer. */
     seller: IStoreOrganization;
 };
+/** Offer input. */
 export declare type IStoreOrder = {
+    /** Array with information on each accepted offer. */
     acceptedOffer: Array<IStoreOffer>;
+    /** Order shopping cart ID, also known as `orderFormId`. */
     orderNumber: Scalars['String'];
 };
+/** Organization input. */
 export declare type IStoreOrganization = {
+    /** Organization ID. */
     identifier: Scalars['String'];
 };
+/** Product input. */
 export declare type IStoreProduct = {
+    /** Array of product images. */
     image: Array<IStoreImage>;
+    /** Product name. */
     name: Scalars['String'];
+    /** Stock Keeping Unit ID. */
     sku: Scalars['String'];
 };
+/** Selected facet input. */
 export declare type IStoreSelectedFacet = {
     key: Scalars['String'];
     value: Scalars['String'];
 };
+/** Session input. */
 export declare type IStoreSession = {
+    /** Session input channel. */
     channel?: Maybe<Scalars['String']>;
+    /** Session input country. */
     country?: Maybe<Scalars['String']>;
+    /** Session input postal code. */
     postalCode?: Maybe<Scalars['String']>;
 };
 export declare type Mutation = {
     __typename?: 'Mutation';
+    /** Update session information. */
     updateSession: StoreSession;
+    /** Returns the order if anything has changed in it, or `null` if the order is valid. */
     validateCart?: Maybe<StoreCart>;
 };
 export declare type MutationUpdateSessionArgs = {
@@ -94,180 +121,296 @@ export declare type QuerySearchArgs = {
     sort?: Maybe<StoreSort>;
     term?: Maybe<Scalars['String']>;
 };
+/** Aggregate offer information, for a given SKU that is available to be fulfilled by multiple sellers. */
 export declare type StoreAggregateOffer = {
     __typename?: 'StoreAggregateOffer';
+    /** Highest price among all sellers. */
     highPrice: Scalars['Float'];
+    /** Lowest price among all sellers. */
     lowPrice: Scalars['Float'];
+    /** Number of sellers selling this SKU. */
     offerCount: Scalars['Int'];
+    /** Array with information on each available offer. */
     offers: Array<StoreOffer>;
+    /** ISO code of the currency used for the offer prices. */
     priceCurrency: Scalars['String'];
 };
+/** Average rating, based on multiple ratings or reviews. */
 export declare type StoreAggregateRating = {
     __typename?: 'StoreAggregateRating';
+    /** Value of the aggregate rating. */
     ratingValue: Scalars['Float'];
+    /** Total number of ratings. */
     reviewCount: Scalars['Int'];
 };
+/** information about the author of a product review or rating. */
 export declare type StoreAuthor = {
     __typename?: 'StoreAuthor';
+    /** Author name. */
     name: Scalars['String'];
 };
+/** Brand of a given product. */
 export declare type StoreBrand = {
     __typename?: 'StoreBrand';
+    /** Brand name. */
     name: Scalars['String'];
 };
+/** List of items consisting of chain linked web pages, ending with the current page. */
 export declare type StoreBreadcrumbList = {
     __typename?: 'StoreBreadcrumbList';
+    /** Array with breadcrumb elements. */
     itemListElement: Array<StoreListItem>;
+    /** Number of breadcrumbs in the list. */
     numberOfItems: Scalars['Int'];
 };
+/** Shopping cart information. */
 export declare type StoreCart = {
     __typename?: 'StoreCart';
+    /** List of shopping cart messages. */
     messages: Array<StoreCartMessage>;
+    /** Order information, including `orderNumber` and `acceptedOffer`. */
     order: StoreOrder;
 };
+/** Shopping cart message. */
 export declare type StoreCartMessage = {
     __typename?: 'StoreCartMessage';
+    /** Shopping cart message status, which can be `INFO`, `WARNING` OR `ERROR`. */
     status: StoreStatus;
+    /** Shopping cart message text. */
     text: Scalars['String'];
 };
+/** Product collection information. */
 export declare type StoreCollection = {
     __typename?: 'StoreCollection';
+    /** List of items consisting of chain linked web pages, ending with the current page. */
     breadcrumbList: StoreBreadcrumbList;
+    /** Collection ID. */
     id: Scalars['ID'];
+    /** Collection meta information. Used for search. */
     meta: StoreCollectionMeta;
+    /** Meta tag data. */
     seo: StoreSeo;
+    /** Corresponding collection URL slug, with which to retrieve this entity. */
     slug: Scalars['String'];
+    /** Collection type. */
     type: StoreCollectionType;
 };
+/** Collection connection pagination information. */
 export declare type StoreCollectionConnection = {
     __typename?: 'StoreCollectionConnection';
+    /** Array with collection connection page edges. */
     edges: Array<StoreCollectionEdge>;
+    /** Collection connection page information. */
     pageInfo: StorePageInfo;
 };
+/** Collection pagination edge. */
 export declare type StoreCollectionEdge = {
     __typename?: 'StoreCollectionEdge';
+    /** Collection pagination cursor. */
     cursor: Scalars['String'];
+    /** Collection pagination node. */
     node: StoreCollection;
 };
+/** Product collection facet, used for search. */
 export declare type StoreCollectionFacet = {
     __typename?: 'StoreCollectionFacet';
+    /** Facet key. */
     key: Scalars['String'];
+    /** Facet value. */
     value: Scalars['String'];
 };
+/** Collection meta information. Used for search. */
 export declare type StoreCollectionMeta = {
     __typename?: 'StoreCollectionMeta';
+    /** List of selected collection facets. */
     selectedFacets: Array<StoreCollectionFacet>;
 };
+/** Product collection type. Possible values are `Department`, `Category`, `Brand` or `Cluster`. */
 export declare const enum StoreCollectionType {
     Brand = "Brand",
     Category = "Category",
     Cluster = "Cluster",
     Department = "Department"
 }
+/** Search facet information. */
 export declare type StoreFacet = {
     __typename?: 'StoreFacet';
+    /** Facet key. */
     key: Scalars['String'];
+    /** Facet label. */
     label: Scalars['String'];
+    /** Facet type. Possible values are `BOOLEAN` and `RANGE`. */
     type: StoreFacetType;
+    /** Array with information on each facet value. */
     values: Array<StoreFacetValue>;
 };
+/** Search facet type. */
 export declare const enum StoreFacetType {
     Boolean = "BOOLEAN",
     Range = "RANGE"
 }
+/** Information of a specific facet value. */
 export declare type StoreFacetValue = {
     __typename?: 'StoreFacetValue';
+    /** Facet value label. */
     label: Scalars['String'];
+    /** Number of items with this facet. */
     quantity: Scalars['Int'];
+    /** Indicates whether facet is selected. */
     selected: Scalars['Boolean'];
+    /** Facet value. */
     value: Scalars['String'];
 };
+/** Image. */
 export declare type StoreImage = {
     __typename?: 'StoreImage';
+    /** Alias for the image. */
     alternateName: Scalars['String'];
+    /** Image URL. */
     url: Scalars['String'];
 };
+/** Item of a list. */
 export declare type StoreListItem = {
     __typename?: 'StoreListItem';
+    /** List item value. */
     item: Scalars['String'];
+    /** Name of the list item. */
     name: Scalars['String'];
+    /** Position of the item in the list. */
     position: Scalars['Int'];
 };
+/** Offer information. */
 export declare type StoreOffer = {
     __typename?: 'StoreOffer';
+    /** Offer item availability. */
     availability: Scalars['String'];
+    /** Offer item condition. */
     itemCondition: Scalars['String'];
+    /** Information on the item being offered. */
     itemOffered: StoreProduct;
+    /** This is displayed as the "from" price in the context of promotions' price comparison. This may change before it reaches the shelf. */
     listPrice: Scalars['Float'];
+    /** Also known as spot price. */
     price: Scalars['Float'];
+    /** ISO code of the currency used for the offer prices. */
     priceCurrency: Scalars['String'];
+    /** 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: Scalars['String'];
+    /** Number of items offered. */
     quantity: Scalars['Int'];
+    /** Seller responsible for the offer. */
     seller: StoreOrganization;
+    /** Computed price before applying coupons, taxes or benefits. This may change before it reaches the shelf. */
     sellingPrice: Scalars['Float'];
 };
+/** Information of a specific order. */
 export declare type StoreOrder = {
     __typename?: 'StoreOrder';
+    /** Array with information on each accepted offer. */
     acceptedOffer: Array<StoreOffer>;
+    /** Order shopping cart ID, also known as `orderFormId`. */
     orderNumber: Scalars['String'];
 };
+/** Organization. */
 export declare type StoreOrganization = {
     __typename?: 'StoreOrganization';
+    /** Organization ID. */
     identifier: Scalars['String'];
 };
+/** Page information. */
 export declare type StorePageInfo = {
     __typename?: 'StorePageInfo';
+    /** Page cursor end. */
     endCursor: Scalars['String'];
+    /** Indicates whether next page exists. */
     hasNextPage: Scalars['Boolean'];
+    /** Indicates whether previous page exists. */
     hasPreviousPage: Scalars['Boolean'];
+    /** Page cursor start. */
     startCursor: Scalars['String'];
+    /** Total number of items (products or collections), not pages. */
     totalCount: Scalars['Int'];
 };
+/** Client profile data. */
 export declare type StorePerson = {
     __typename?: 'StorePerson';
+    /** Client email. */
     email: Scalars['String'];
+    /** Client last name. */
     familyName: Scalars['String'];
+    /** Client first name. */
     givenName: Scalars['String'];
+    /** Client ID. */
     id: Scalars['String'];
 };
+/** Product information. */
 export declare type StoreProduct = {
     __typename?: 'StoreProduct';
+    /** Array of additional properties. */
     additionalProperty: Array<StorePropertyValue>;
+    /** Aggregate ratings data. */
     aggregateRating: StoreAggregateRating;
+    /** Product brand. */
     brand: StoreBrand;
+    /** List of items consisting of chain linked web pages, ending with the current page. */
     breadcrumbList: StoreBreadcrumbList;
+    /** Product description. */
     description: Scalars['String'];
+    /** Global Trade Item Number. */
     gtin: Scalars['String'];
+    /** Array of images. */
     image: Array<StoreImage>;
+    /** Indicates product group related to this product. */
     isVariantOf: StoreProductGroup;
+    /** Product name. */
     name: Scalars['String'];
+    /** Aggregate offer information. */
     offers: StoreAggregateOffer;
+    /** Product ID. */
     productID: Scalars['String'];
+    /** Array with review information. */
     review: Array<StoreReview>;
+    /** Meta tag data. */
     seo: StoreSeo;
+    /** Stock Keeping Unit ID. */
     sku: Scalars['String'];
+    /** Corresponding collection URL slug, with which to retrieve this entity. */
     slug: Scalars['String'];
 };
+/** Product connection pagination information. */
 export declare type StoreProductConnection = {
     __typename?: 'StoreProductConnection';
+    /** Array with product connection page edges. */
     edges: Array<StoreProductEdge>;
+    /** Product connection page information. */
     pageInfo: StorePageInfo;
 };
+/** Product pagination edge. */
 export declare type StoreProductEdge = {
     __typename?: 'StoreProductEdge';
+    /** Product pagination cursor. */
     cursor: Scalars['String'];
+    /** Product pagination node. */
     node: StoreProduct;
 };
+/** Product group information. */
 export declare type StoreProductGroup = {
     __typename?: 'StoreProductGroup';
+    /** Array of additional properties. */
     additionalProperty: Array<StorePropertyValue>;
+    /** Array of variants related to product group. */
     hasVariant: Array<StoreProduct>;
+    /** Product group name. */
     name: Scalars['String'];
+    /** Product group ID. */
     productGroupID: Scalars['String'];
 };
+/** Properties that can be associated with products and products groups. */
 export declare type StorePropertyValue = {
     __typename?: 'StorePropertyValue';
+    /** Property name. */
     name: Scalars['String'];
+    /** Property value. */
     value: Scalars['String'];
 };
 export declare type StoreReview = {
@@ -280,10 +423,14 @@ export declare type StoreReviewRating = {
     bestRating: Scalars['Float'];
     ratingValue: Scalars['Float'];
 };
+/** Search result. */
 export declare type StoreSearchResult = {
     __typename?: 'StoreSearchResult';
+    /** Array of search result facets. */
     facets: Array<StoreFacet>;
+    /** Search result products. */
     products: StoreProductConnection;
+    /** Search result suggestions. */
     suggestions: StoreSuggestions;
 };
 export declare type StoreSeo = {
@@ -293,12 +440,17 @@ export declare type StoreSeo = {
     title: Scalars['String'];
     titleTemplate: Scalars['String'];
 };
+/** Session information. */
 export declare type StoreSession = {
     __typename?: 'StoreSession';
+    /** Session channel. */
     channel?: Maybe<Scalars['String']>;
+    /** Session country. */
     country?: Maybe<Scalars['String']>;
+    /** Session postal code. */
     postalCode?: Maybe<Scalars['String']>;
 };
+/** Product sorting options used in search. */
 export declare const enum StoreSort {
     DiscountDesc = "discount_desc",
     NameAsc = "name_asc",
@@ -314,8 +466,11 @@ export declare const enum StoreStatus {
     Info = "INFO",
     Warning = "WARNING"
 }
+/** Suggestions information. */
 export declare type StoreSuggestions = {
     __typename?: 'StoreSuggestions';
+    /** Array with suggestion products' information. */
     products?: Maybe<Array<StoreProduct>>;
+    /** Array with suggestion terms. */
     terms?: Maybe<Array<Scalars['String']>>;
 };