@faststore/api 2.2.42 → 2.2.44

package/dist/esm/src/platforms/vtex/clients/commerce/types/CategoryTree.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"CategoryTree.js","sourceRoot":"","sources":["../../../../../../../../src/platforms/vtex/clients/commerce/types/CategoryTree.ts"],"names":[],"mappings":""}

package/dist/esm/src/platforms/vtex/clients/commerce/types/Newsletter.d.ts

@@ -0,0 +1,4 @@
+export interface MasterDataResponse {
+    Id: string;
+    Href: string;
+}

package/dist/esm/src/platforms/vtex/clients/commerce/types/Newsletter.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Newsletter.js.map

package/dist/esm/src/platforms/vtex/clients/commerce/types/Newsletter.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Newsletter.js","sourceRoot":"","sources":["../../../../../../../../src/platforms/vtex/clients/commerce/types/Newsletter.ts"],"names":[],"mappings":""}

package/dist/esm/src/platforms/vtex/clients/commerce/types/OrderForm.d.ts

@@ -0,0 +1,371 @@
+export interface OrderFormInputItem {
+    id: string;
+    quantity: number;
+    seller: string;
+    index?: number;
+    attachments?: Attachment[];
+}
+export interface Attachment {
+    name: string;
+    content: Record<string, string>;
+}
+export interface OrderFormItem {
+    id: string;
+    name: string;
+    detailUrl: string;
+    imageUrl: string;
+    skuName: string;
+    quantity: number;
+    uniqueId: string;
+    productId: string;
+    refId: string;
+    ean: string;
+    priceValidUntil: string;
+    price: number;
+    tax: number;
+    listPrice: number;
+    sellingPrice: number;
+    rewardValue: number;
+    isGift: boolean;
+    parentItemIndex: number | null;
+    parentAssemblyBinding: string | null;
+    productCategoryIds: string;
+    priceTags: string[];
+    manualPrice: number | null;
+    measurementUnit: string;
+    additionalInfo: {
+        brandName: string;
+        brandId: string;
+        offeringInfo: any | null;
+        offeringType: any | null;
+        offeringTypeId: any | null;
+    };
+    productCategories: Record<string, string>;
+    productRefId: string;
+    seller: string;
+    sellerChain: string[];
+    availability: string;
+    unitMultiplier: number;
+    skuSpecifications?: SKUSpecification[] | null;
+    priceDefinition: {
+        calculatedSellingPrice: number;
+        sellingPrices: SellingPrice[];
+        total: number;
+    };
+    attachments: Attachment[];
+}
+export interface SKUSpecification {
+    fieldName: string;
+    fieldValues: string[];
+}
+export interface AdditionalInfo {
+    dimension: null;
+    brandName: string;
+    brandId: string;
+    offeringInfo: null;
+    offeringType: null;
+    offeringTypeId: null;
+}
+export interface PriceDefinition {
+    calculatedSellingPrice: number;
+    total: number;
+    sellingPrices: SellingPrice[];
+}
+export interface SellingPrice {
+    value: number;
+    quantity: number;
+}
+export interface PriceTag {
+    name: string;
+    value: number;
+    rawValue: number;
+    isPercentual: boolean;
+    identifier: string;
+}
+export interface OrderForm {
+    orderFormId: string;
+    salesChannel: string;
+    loggedIn: boolean;
+    isCheckedIn: boolean;
+    storeId: string | null;
+    checkedInPickupPointId: string | null;
+    allowManualPrice: boolean;
+    canEditData: boolean;
+    userProfileId: string | null;
+    userType: string | null;
+    ignoreProfileData: boolean;
+    value: number;
+    messages: any[];
+    items: OrderFormItem[];
+    selectableGifts: any[];
+    totalizers: Array<{
+        id: string;
+        name: string;
+        value: number;
+    }>;
+    shippingData: ShippingData | null;
+    clientProfileData: ClientProfileData | null;
+    paymentData: PaymentData;
+    marketingData: OrderFormMarketingData | null;
+    sellers: Array<{
+        id: string;
+        name: string;
+        logo: string;
+    }>;
+    clientPreferencesData: {
+        locale: string;
+        optinNewsLetter: any | null;
+    };
+    commercialConditionData: any | null;
+    storePreferencesData: {
+        countryCode: string;
+        currencyCode: string;
+        currencyFormatInfo: {
+            currencyDecimalDigits: number;
+            currencyDecimalSeparator: string;
+            currencyGroupSeparator: string;
+            currencyGroupSize: number;
+            startsWithCurrencySymbol: boolean;
+        };
+        currencyLocale: number;
+        currencySymbol: string;
+        saveUserData: boolean;
+        timeZone: string;
+    };
+    giftRegistryData: any | null;
+    openTextField: any | null;
+    invoiceData: any | null;
+    customData: OrderFormCustomData | null;
+    itemMetadata: {
+        items: MetadataItem[];
+    } | null;
+    hooksData: any | null;
+    ratesAndBenefitsData: {
+        rateAndBenefitsIdentifiers: any[];
+        teaser: any[];
+    };
+    subscriptionData: SubscriptionData | null;
+    itemsOrdination: any | null;
+}
+export interface OrderFormCustomData {
+    customApps: Array<{
+        fields: Record<string, string>;
+        id: string;
+        major: number;
+    }>;
+}
+export interface OrderFormMarketingData {
+    utmCampaign?: string;
+    utmMedium?: string;
+    utmSource?: string;
+    utmiCampaign?: string;
+    utmiPart?: string;
+    utmipage?: string;
+    marketingTags?: string;
+    coupon?: string;
+}
+export interface PaymentData {
+    installmentOptions: Array<{
+        paymentSystem: string;
+        bin: string | null;
+        paymentName: string | null;
+        paymentGroupName: string | null;
+        value: number;
+        installments: Array<{
+            count: number;
+            hasInterestRate: false;
+            interestRate: number;
+            value: number;
+            total: number;
+            sellerMerchantInstallments: Array<{
+                count: number;
+                hasInterestRate: false;
+                interestRate: number;
+                value: number;
+                total: number;
+            }>;
+        }>;
+    }>;
+    paymentSystems: Array<{
+        id: string;
+        name: string;
+        groupName: string;
+        validator: {
+            regex: string;
+            mask: string;
+            cardCodeRegex: string;
+            cardCodeMask: string;
+            weights: number[];
+            useCvv: boolean;
+            useExpirationDate: boolean;
+            useCardHolderName: boolean;
+            useBillingAddress: boolean;
+        };
+        stringId: string;
+        template: string;
+        requiresDocument: boolean;
+        isCustom: boolean;
+        description: string | null;
+        requiresAuthentication: boolean;
+        dueDate: string;
+        availablePayments: any | null;
+    }>;
+    payments: any[];
+    giftCards: any[];
+    giftCardMessages: any[];
+    availableAccounts: any[];
+    availableTokens: any[];
+}
+export interface ClientProfileData {
+    email: string | null;
+    firstName: string | null;
+    lastName: string | null;
+    document: string | null;
+    documentType: string | null;
+    phone: string | null;
+    corporateName: string | null;
+    tradeName: string | null;
+    corporateDocument: string | null;
+    stateInscription: string | null;
+    corporatePhone: string | null;
+    isCorporate: boolean;
+    profileCompleteOnLoading: boolean;
+    profileErrorOnLoading: boolean;
+    customerClass: string | null;
+}
+export interface ShippingData {
+    address: CheckoutAddress | null;
+    logisticsInfo: LogisticsInfo[];
+    selectedAddresses: CheckoutAddress[];
+    availableAddresses: CheckoutAddress[];
+    pickupPoints: PickupPoint[];
+}
+export interface PickupPoint {
+    friendlyName: string;
+    address: CheckoutAddress;
+    additionalInfo: string;
+    id: string;
+    businessHours: BusinessHour[];
+}
+export interface BusinessHour {
+    DayOfWeek: number;
+    ClosingTime: string;
+    OpeningTime: string;
+}
+export interface LogisticsInfo {
+    addressId: string | null;
+    deliveryChannels: DeliveryChannel[];
+    itemId: string;
+    itemIndex: number;
+    shipsTo: string[];
+    slas: SLA[];
+    selectedDeliveryChannel: string | null;
+    selectedSla: string | null;
+}
+export interface SLA {
+    id: string;
+    deliveryChannel: string;
+    name: string;
+    deliveryIds: DeliveryId[];
+    shippingEstimate: string;
+    shippingEstimateDate: string | null;
+    lockTTL: string | null;
+    availableDeliveryWindows: AvailableDeliveryWindows[];
+    deliveryWindow: DeliveryWindow | null;
+    price: number;
+    listPrice: number;
+    tax: number;
+    pickupStoreInfo: {
+        isPickupStore: boolean;
+        friendlyName: string | null;
+        address: CheckoutAddress | null;
+        additionalInfo: any | null;
+        dockId: string | null;
+    };
+    pickupPointId: string | null;
+    pickupDistance: number | null;
+    polygonName: string | null;
+    transitTime: string | null;
+}
+export interface DeliveryWindow {
+    startDateUtc: string;
+    endDateUtc: string;
+}
+export interface AvailableDeliveryWindows {
+    startDateUtc: string;
+    endDateUtc: string;
+    price: number;
+    lisPrice?: number;
+    tax: number;
+}
+export interface DeliveryId {
+    courierId: string;
+    warehouseId: string;
+    dockId: string;
+    courierName: string;
+    quantity: number;
+}
+export interface DeliveryChannel {
+    id: string;
+}
+export interface CheckoutAddress {
+    addressId: string;
+    addressType: string;
+    city: string | null;
+    complement: string | null;
+    country: string;
+    geoCoordinates: number[];
+    neighborhood: string | null;
+    number: string | null;
+    postalCode: string | null;
+    receiverName: string | null;
+    reference: string | null;
+    state: string | null;
+    street: string | null;
+    isDisposable: boolean;
+}
+export interface MetadataItem {
+    id: string;
+    name: string;
+    imageUrl: string;
+    detailUrl: string;
+    seller: string;
+    assemblyOptions: AssemblyOption[];
+    skuName: string;
+    productId: string;
+    refId: string;
+    ean: string | null;
+}
+export interface AssemblyOption {
+    id: string;
+    name: string;
+    composition: Composition | null;
+}
+export interface SubscriptionDataEntry {
+    executionCount: number;
+    itemIndex: number;
+    plan: {
+        frequency: {
+            interval: number;
+            periodicity: 'YEAR' | 'MONTH' | 'WEEK' | 'DAY';
+        };
+        type: string;
+        validity: unknown;
+    };
+}
+export interface CompositionItem {
+    id: string;
+    minQuantity: number;
+    maxQuantity: number;
+    initialQuantity: number;
+    priceTable: string;
+    seller: string;
+}
+export interface Composition {
+    minQuantity: number;
+    maxQuantity: number;
+    items: CompositionItem[];
+}
+export interface SubscriptionData {
+    subscriptions: SubscriptionDataEntry[];
+}

package/dist/esm/src/platforms/vtex/clients/commerce/types/OrderForm.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=OrderForm.js.map

package/dist/esm/src/platforms/vtex/clients/commerce/types/OrderForm.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"OrderForm.js","sourceRoot":"","sources":["../../../../../../../../src/platforms/vtex/clients/commerce/types/OrderForm.ts"],"names":[],"mappings":""}

package/dist/esm/src/platforms/vtex/clients/commerce/types/Portal.d.ts

@@ -0,0 +1,17 @@
+export type PortalPagetype = CollectionPageType | FallbackPageType;
+export interface CollectionPageType {
+    id: number;
+    name: string;
+    url: string;
+    title: string;
+    metaTagDescription: string;
+    pageType: 'Brand' | 'Category' | 'Department' | 'SubCategory' | 'Product' | 'Collection' | 'Cluster';
+}
+export interface FallbackPageType {
+    id: null;
+    name: null | string;
+    url: null | string;
+    title: null;
+    metaTagDescription: null;
+    pageType: 'NotFound' | 'FullText';
+}

package/dist/esm/src/platforms/vtex/clients/commerce/types/Portal.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Portal.js.map

package/dist/esm/src/platforms/vtex/clients/commerce/types/Portal.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Portal.js","sourceRoot":"","sources":["../../../../../../../../src/platforms/vtex/clients/commerce/types/Portal.ts"],"names":[],"mappings":""}

package/dist/esm/src/platforms/vtex/clients/commerce/types/Product.d.ts

@@ -0,0 +1,174 @@
+export interface PortalProduct {
+    productId: string;
+    productName: string;
+    brand: string;
+    brandId: number;
+    brandImageUrl: null | string;
+    linkText: string;
+    productReference: string;
+    productReferenceCode: string;
+    categoryId: string;
+    productTitle: string;
+    metaTagDescription: string;
+    releaseDate: Date;
+    clusterHighlights: unknown;
+    productClusters: unknown;
+    searchableClusters: unknown;
+    categories: Category[];
+    categoriesIds: CategoriesId[];
+    link: string;
+    description: string;
+    items: Item[];
+}
+declare enum Category {
+    Office = "/Office/",
+    OfficeChairs = "/Office/Chairs/"
+}
+declare enum CategoriesId {
+    The9282 = "/9282/",
+    The92829296 = "/9282/9296/"
+}
+interface Item {
+    itemId: string;
+    name: string;
+    nameComplete: string;
+    complementName: string;
+    ean: string;
+    referenceId: ReferenceId[];
+    measurementUnit: MeasurementUnit;
+    unitMultiplier: number;
+    modalType: null;
+    isKit: boolean;
+    images: Image[];
+    sellers: Seller[];
+    videos: unknown[];
+    estimatedDateArrival: null;
+}
+interface Image {
+    imageId: string;
+    imageLabel: string;
+    imageTag: string;
+    imageUrl: string;
+    imageText: string;
+    imageLastModified: Date;
+}
+declare enum MeasurementUnit {
+    Un = "un"
+}
+interface ReferenceId {
+    key: Key;
+    value: string;
+}
+declare enum Key {
+    RefId = "RefId"
+}
+interface Seller {
+    sellerId: string;
+    sellerName: SellerName;
+    addToCartLink: string;
+    sellerDefault: boolean;
+    commertialOffer: CommertialOffer;
+}
+interface CommertialOffer {
+    deliverySlaSamplesPerRegion: DeliverySlaSamplesPerRegion;
+    installments: Installment[];
+    discountHighLight: unknown[];
+    giftSkuIds: unknown[];
+    teasers: unknown[];
+    buyTogether: unknown[];
+    itemMetadataAttachment: unknown[];
+    price: number;
+    listPrice: number;
+    priceWithoutDiscount: number;
+    rewardValue: number;
+    priceValidUntil: Date;
+    availableQuantity: number;
+    isAvailable: boolean;
+    tax: number;
+    deliverySlaSamples: DeliverySlaSample[];
+    getInfoErrorMessage: null;
+    cacheVersionUsedToCallCheckout: string;
+    paymentOptions: PaymentOptions;
+}
+interface DeliverySlaSample {
+    deliverySlaPerTypes: unknown[];
+    region: null;
+}
+interface DeliverySlaSamplesPerRegion {
+    the0: DeliverySlaSample;
+}
+interface Installment {
+    value: number;
+    interestRate: number;
+    totalValuePlusInterestRate: number;
+    numberOfInstallments: number;
+    paymentSystemName: PaymentSystemNameEnum;
+    paymentSystemGroupName: GroupName;
+    name: Name;
+}
+declare enum Name {
+    BoletoBancárioÀVista = "Boleto Banc\u00E1rio \u00E0 vista",
+    FreeÀVista = "Free \u00E0 vista"
+}
+declare enum GroupName {
+    BankInvoicePaymentGroup = "bankInvoicePaymentGroup",
+    Custom201PaymentGroupPaymentGroup = "custom201PaymentGroupPaymentGroup"
+}
+declare enum PaymentSystemNameEnum {
+    BoletoBancário = "Boleto Banc\u00E1rio",
+    Free = "Free"
+}
+interface PaymentOptions {
+    installmentOptions: InstallmentOption[];
+    paymentSystems: PaymentSystem[];
+    payments: unknown[];
+    giftCards: unknown[];
+    giftCardMessages: unknown[];
+    availableAccounts: unknown[];
+    availableTokens: unknown[];
+}
+interface InstallmentOption {
+    paymentSystem: string;
+    bin: null;
+    paymentName: PaymentSystemNameEnum;
+    paymentGroupName: GroupName;
+    value: number;
+    installments: InstallmentElement[];
+}
+interface InstallmentElement {
+    count: number;
+    hasInterestRate: boolean;
+    interestRate: number;
+    value: number;
+    total: number;
+    sellerMerchantInstallments?: InstallmentElement[];
+    id?: Id;
+}
+declare enum Id {
+    Storeframework = "STOREFRAMEWORK"
+}
+interface PaymentSystem {
+    id: number;
+    name: PaymentSystemNameEnum;
+    groupName: GroupName;
+    validator: null;
+    stringId: string;
+    template: Template;
+    requiresDocument: boolean;
+    isCustom: boolean;
+    description: Description | null;
+    requiresAuthentication: boolean;
+    dueDate: Date;
+    availablePayments: null;
+}
+declare enum Description {
+    FreePayToTestCheckoutPayments = "Free pay to test checkout payments"
+}
+declare enum Template {
+    BankInvoicePaymentGroupTemplate = "bankInvoicePaymentGroup-template",
+    Custom201PaymentGroupPaymentGroupTemplate = "custom201PaymentGroupPaymentGroup-template"
+}
+declare enum SellerName {
+    Vtex = "VTEX"
+}
+export {};

package/dist/esm/src/platforms/vtex/clients/commerce/types/Product.js

@@ -0,0 +1,52 @@
+var Category;
+(function (Category) {
+    Category["Office"] = "/Office/";
+    Category["OfficeChairs"] = "/Office/Chairs/";
+})(Category || (Category = {}));
+var CategoriesId;
+(function (CategoriesId) {
+    CategoriesId["The9282"] = "/9282/";
+    CategoriesId["The92829296"] = "/9282/9296/";
+})(CategoriesId || (CategoriesId = {}));
+var MeasurementUnit;
+(function (MeasurementUnit) {
+    MeasurementUnit["Un"] = "un";
+})(MeasurementUnit || (MeasurementUnit = {}));
+var Key;
+(function (Key) {
+    Key["RefId"] = "RefId";
+})(Key || (Key = {}));
+var Name;
+(function (Name) {
+    Name["BoletoBanc\u00E1rio\u00C0Vista"] = "Boleto Banc\u00E1rio \u00E0 vista";
+    Name["Free\u00C0Vista"] = "Free \u00E0 vista";
+})(Name || (Name = {}));
+var GroupName;
+(function (GroupName) {
+    GroupName["BankInvoicePaymentGroup"] = "bankInvoicePaymentGroup";
+    GroupName["Custom201PaymentGroupPaymentGroup"] = "custom201PaymentGroupPaymentGroup";
+})(GroupName || (GroupName = {}));
+var PaymentSystemNameEnum;
+(function (PaymentSystemNameEnum) {
+    PaymentSystemNameEnum["BoletoBanc\u00E1rio"] = "Boleto Banc\u00E1rio";
+    PaymentSystemNameEnum["Free"] = "Free";
+})(PaymentSystemNameEnum || (PaymentSystemNameEnum = {}));
+var Id;
+(function (Id) {
+    Id["Storeframework"] = "STOREFRAMEWORK";
+})(Id || (Id = {}));
+var Description;
+(function (Description) {
+    Description["FreePayToTestCheckoutPayments"] = "Free pay to test checkout payments";
+})(Description || (Description = {}));
+var Template;
+(function (Template) {
+    Template["BankInvoicePaymentGroupTemplate"] = "bankInvoicePaymentGroup-template";
+    Template["Custom201PaymentGroupPaymentGroupTemplate"] = "custom201PaymentGroupPaymentGroup-template";
+})(Template || (Template = {}));
+var SellerName;
+(function (SellerName) {
+    SellerName["Vtex"] = "VTEX";
+})(SellerName || (SellerName = {}));
+export {};
+//# sourceMappingURL=Product.js.map

package/dist/esm/src/platforms/vtex/clients/commerce/types/Product.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Product.js","sourceRoot":"","sources":["../../../../../../../../src/platforms/vtex/clients/commerce/types/Product.ts"],"names":[],"mappings":"AAuBA,IAAK,QAGJ;AAHD,WAAK,QAAQ;IACX,+BAAmB,CAAA;IACnB,4CAAgC,CAAA;AAClC,CAAC,EAHI,QAAQ,KAAR,QAAQ,QAGZ;AAED,IAAK,YAGJ;AAHD,WAAK,YAAY;IACf,kCAAkB,CAAA;IAClB,2CAA2B,CAAA;AAC7B,CAAC,EAHI,YAAY,KAAZ,YAAY,QAGhB;AA8BD,IAAK,eAEJ;AAFD,WAAK,eAAe;IAClB,4BAAS,CAAA;AACX,CAAC,EAFI,eAAe,KAAf,eAAe,QAEnB;AAOD,IAAK,GAEJ;AAFD,WAAK,GAAG;IACN,sBAAe,CAAA;AACjB,CAAC,EAFI,GAAG,KAAH,GAAG,QAEP;AAmDD,IAAK,IAGJ;AAHD,WAAK,IAAI;IACP,4EAAgD,CAAA;IAChD,6CAA2B,CAAA;AAC7B,CAAC,EAHI,IAAI,KAAJ,IAAI,QAGR;AAED,IAAK,SAGJ;AAHD,WAAK,SAAS;IACZ,gEAAmD,CAAA;IACnD,oFAAuE,CAAA;AACzE,CAAC,EAHI,SAAS,KAAT,SAAS,QAGb;AAED,IAAK,qBAGJ;AAHD,WAAK,qBAAqB;IACxB,qEAAkC,CAAA;IAClC,sCAAa,CAAA;AACf,CAAC,EAHI,qBAAqB,KAArB,qBAAqB,QAGzB;AA+BD,IAAK,EAEJ;AAFD,WAAK,EAAE;IACL,uCAAiC,CAAA;AACnC,CAAC,EAFI,EAAE,KAAF,EAAE,QAEN;AAiBD,IAAK,WAEJ;AAFD,WAAK,WAAW;IACd,mFAAoE,CAAA;AACtE,CAAC,EAFI,WAAW,KAAX,WAAW,QAEf;AAED,IAAK,QAIJ;AAJD,WAAK,QAAQ;IACX,gFAAoE,CAAA;IACpE,oGAC8C,CAAA;AAChD,CAAC,EAJI,QAAQ,KAAR,QAAQ,QAIZ;AAED,IAAK,UAEJ;AAFD,WAAK,UAAU;IACb,2BAAa,CAAA;AACf,CAAC,EAFI,UAAU,KAAV,UAAU,QAEd"}

package/dist/esm/src/platforms/vtex/clients/commerce/types/Region.d.ts

@@ -0,0 +1,19 @@
+export interface RegionInput {
+    postalCode?: string | null;
+    geoCoordinates?: GeoCoordinates | null;
+    country: string;
+    salesChannel?: string | null;
+}
+export interface Seller {
+    id: string;
+    name: string;
+    logo: string;
+}
+export interface GeoCoordinates {
+    latitude: GLfloat;
+    longitude: GLfloat;
+}
+export interface Region {
+    id: string;
+    sellers: Seller[];
+}

package/dist/esm/src/platforms/vtex/clients/commerce/types/Region.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=Region.js.map

package/dist/esm/src/platforms/vtex/clients/commerce/types/Region.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Region.js","sourceRoot":"","sources":["../../../../../../../../src/platforms/vtex/clients/commerce/types/Region.ts"],"names":[],"mappings":""}