pim-import 2.78.0 → 2.78.3

package/types/pim/config.d.ts

@@ -0,0 +1,13 @@
+export interface Config {
+    baseURL: string;
+    username?: string;
+    password?: string;
+    timeout?: number;
+    sslverify?: boolean;
+}
+export declare const defaultConfig: Readonly<Config>;
+export declare let config: Config;
+export declare const resetConfig: () => void;
+export declare const checkConfig: (skipInit?: boolean) => void;
+export declare const init: (providedConfig?: Config | undefined) => void;
+export declare const getConfig: () => Readonly<Config>;

package/types/pim/endpoints.d.ts

@@ -0,0 +1,20 @@
+import { AvailableCatalogs } from "../types";
+import { CatalogDetails } from "../resources/CatalogDetails";
+import { Audit } from "../resources/Audit";
+import { CollectionModels } from "../resources/CollectionModels";
+import { CollectionSubModels } from "../resources/CollectionSubModels";
+import { CollectionSubFamilies } from "../resources/CollectionSubFamilies";
+import { FamilyDetails } from "../resources/FamilyDetails";
+declare type AvailableOtherCatalogDataEndpoint = "models" | "submodels" | "subfamilies";
+export declare const getPimDomain: () => string;
+export declare const getCatalogTaxonomiesHierarchy: (catalogCode: AvailableCatalogs, jsonFile?: null | undefined) => Promise<CatalogDetails>;
+export declare const getDictionary: () => Promise<any>;
+export declare const getAllProducts: (lastModified?: string | null, catalogCode?: AvailableCatalogs | null) => Promise<any>;
+export declare const getLatestProducts: (catalogCode: AvailableCatalogs, lastModified: string, limit: number) => Promise<any>;
+export declare const getProductDetails: (code: string) => Promise<any>;
+export declare const getAudit: (lastModified?: string) => Promise<Audit[]>;
+export declare const getStaticDailyProducts: (catalogCode: AvailableCatalogs, day: string, saveToS3?: boolean) => Promise<any>;
+declare type AvailableOtherCatalogCollection = CollectionModels | CollectionSubModels | CollectionSubFamilies;
+export declare const getOtherCatalogData: <T extends AvailableOtherCatalogCollection>(endpoint: AvailableOtherCatalogDataEndpoint, offset?: number, limit?: number) => Promise<T>;
+export declare const getFamilies: () => Promise<FamilyDetails[]>;
+export {};

package/types/pim/methods/catalogs.d.ts

@@ -0,0 +1,21 @@
+import { AvailableCatalogs, PaginationResults } from "../../types";
+import type { Entry } from "contentful-management/dist/typings/entities/entry";
+export declare const updateSubFamiliesRelToEntry: (entry: Entry, subFamilyIds: string[], field?: string) => Promise<Entry>;
+export declare const getCategoryTopicCode: (categoryPimCode: string, catalogCode: AvailableCatalogs) => string;
+export declare const getCategoryTopicId: (categoryPimCode: string, catalogCode: AvailableCatalogs) => string;
+export declare const importCatalogPage: (catalogEntry: Entry) => Promise<Entry>;
+export declare const importCategories: (catalogCode: AvailableCatalogs, offset?: number, limit?: number, s3FilePath?: string) => Promise<PaginationResults | null>;
+export declare const deleteAllCategoriesAndFamiliesData: (catalogCode: AvailableCatalogs) => Promise<{
+    topicCategory: {
+        deleted: number;
+        total: number;
+    };
+    topicSubFamily: {
+        deleted: number;
+        total: number;
+    };
+    page: {
+        deleted: number;
+        total: number;
+    };
+}>;

package/types/pim/methods/dailyProductsUpdate.d.ts

@@ -0,0 +1,2 @@
+import { AvailableCatalogs, PaginationResults } from "../../types";
+export declare const dailyProductsUpdate: (catalog: AvailableCatalogs, day: string, offset?: number, limit?: number, s3FilePath?: string) => Promise<PaginationResults>;

package/types/pim/methods/dictionary.d.ts

@@ -0,0 +1,6 @@
+export declare const contentTypeId = "globalJsonFile";
+export declare const entryId = "globalJsonProductFields";
+export declare const importDictionaryIcons: (skipAlreadyExistsCheck?: boolean) => Promise<any>;
+export declare const importDictionaryFields: (offset?: number, limit?: number) => Promise<any>;
+export declare const importDictionaryProductLine: () => Promise<any>;
+export declare const importDictionaryProductSubLine: () => Promise<any>;

package/types/pim/methods/families.d.ts

@@ -0,0 +1,4 @@
+import type { Entry } from "contentful-management/dist/typings/entities/entry";
+import { PaginationResults } from "../../types";
+export declare const createOrUpdatePage: (familyEntry: Entry) => Promise<Entry>;
+export declare const importFamilies: (offset?: number, limit?: number) => Promise<PaginationResults>;

package/types/pim/methods/latestProducts.d.ts

@@ -0,0 +1,12 @@
+import { AvailableCatalogs } from "../../types";
+export declare const importLatestProducts: (catalog: AvailableCatalogs, lastModified: string, limit: number, lastProductCode?: string | undefined, familyCodeIn?: string[] | undefined, subFamilyCodeIn?: string[] | undefined) => Promise<{
+    catalog: AvailableCatalogs;
+    limit: number;
+    lastModified: string;
+    lastProductLastModified: string;
+    lastProductCode: string | undefined;
+    familyCodeIn: string[] | undefined;
+    subFamilyCodeIn: string[] | undefined;
+    count: number;
+    completed: boolean;
+}>;

package/types/pim/methods/models.d.ts

@@ -0,0 +1,2 @@
+import { PaginationResults } from "../../types";
+export declare const importModels: (offset?: number, limit?: number) => Promise<PaginationResults>;

package/types/pim/methods/pages/catalogs.d.ts

@@ -0,0 +1,3 @@
+import { AvailableCatalogs } from "../../../types";
+export declare const createOrUpdateCatalogPages: () => Promise<void>;
+export declare const createOrUpdateCatalogPageByCode: (catalogCode: AvailableCatalogs) => Promise<void>;

package/types/pim/methods/pages/families.d.ts

@@ -0,0 +1,6 @@
+export declare const createOrUpdateFamilyPages: (offset: number, limit?: number) => Promise<{
+    offset: number;
+    limit: number;
+    completed: boolean;
+}>;
+export declare const createOrUpdateFamilyPageByCode: (familyCode: string) => Promise<void>;

package/types/pim/methods/pages/subfamilies.d.ts

@@ -0,0 +1,12 @@
+import { AvailableCatalogs } from "../../../types";
+export declare const createOrUpdateSubFamilyPages: (offset: number, limit?: number) => Promise<{
+    offset: number;
+    limit: number;
+    completed: boolean;
+}>;
+export declare const createOrUpdateSubFamilyPageByCode: (subfamilyCode: string) => Promise<void>;
+export declare const createOrUpdateSubFamilyPagesByCatalog: (catalogCode: AvailableCatalogs, offset: number, limit?: number) => Promise<{
+    offset: number;
+    limit: number;
+    completed: boolean;
+}>;

package/types/pim/methods/products.d.ts

@@ -0,0 +1,47 @@
+import { ProductDetails } from "../../resources/ProductDetails";
+import { AvailableCatalogs } from "../../types";
+import type { Entry } from "contentful-management/dist/typings/entities/entry";
+export declare type AvailableProductStatus = "To be review" | "Published" | "Unpublished";
+export declare type AvailableRelationFieldKeys = "accessories" | "accessoryOf" | "bulbs" | "spareparts";
+export declare const importProduct: (productDetails: ProductDetails, catalog: AvailableCatalogs, familyCodeIn?: string[] | undefined, subFamilyCodeIn?: string[] | undefined) => Promise<boolean>;
+export declare const setProductRelationships: (code: string, fieldKey?: AvailableRelationFieldKeys | null) => Promise<void>;
+export declare const setProductsRelationships: (catalog: AvailableCatalogs, lastModified: string, fieldKey: AvailableRelationFieldKeys | null, offset?: number, limit?: number, s3FilePath?: string) => Promise<{
+    offset: number;
+    limit: number;
+    completed: boolean;
+    s3FilePath: string;
+    total?: undefined;
+} | {
+    offset: number;
+    limit: number;
+    completed: boolean;
+    s3FilePath: string;
+    total: number;
+}>;
+export declare const getAllProductEntriesByCatalog: (catalog: AvailableCatalogs, limit?: number, select?: string) => Promise<Entry[]>;
+export declare const audit: (lastModified: string, catalog: AvailableCatalogs, offset?: number, limit?: number, s3FilePath?: string) => Promise<{
+    offset: number;
+    limit: number;
+    completed: boolean;
+    s3FilePath: string;
+    total: number;
+} | {
+    offset: number;
+    limit: number;
+    completed: boolean;
+    s3FilePath: string;
+    total?: undefined;
+}>;
+export declare const importProductByCode: (code: string, catalog: AvailableCatalogs) => Promise<void>;
+export declare const generateTechSpecPdf: (topicProductId: string) => Promise<string | undefined>;
+export declare const setProductsAutodescription: (catalog: AvailableCatalogs, offset?: number, limit?: number) => Promise<{
+    catalog: AvailableCatalogs;
+    offset: number;
+    limit: number;
+    completed: boolean;
+    total: number;
+}>;
+export declare const setProductAutodescriptionByTopicId: (topicProductId: string) => Promise<any>;
+export declare const getProductAutodescription: (topicProductId: string) => Promise<any>;
+export declare const removeProductFromColorVariantsByProductLine: (productLineCode: string) => Promise<void>;
+export declare const removeAllProductModelProductRelations: (modelCode: string) => Promise<void>;

package/types/pim/methods/subfamilies.d.ts

@@ -0,0 +1,13 @@
+import type { Entry } from "contentful-management/dist/typings/entities/entry";
+import { PaginationResults, CfLocalizedEntryField, AvailableCatalogs } from "../../types";
+import { pageResponse } from "../../algolia/families";
+export declare const getSubFamilyPageSlugs: (catalogPage: Entry, categoryPage: Entry, subFamilyEntry: Entry) => Promise<CfLocalizedEntryField>;
+export declare const createOrUpdatePage: (subFamilyEntry: Entry) => Promise<Entry>;
+export declare const importSubFamilies: (offset: number | undefined, limit: number | undefined, catalog: AvailableCatalogs) => Promise<PaginationResults>;
+export declare const getSubFamilySlugDetails: (topicSubFamily: Entry) => Promise<{
+    catalogPageSlugs: any;
+    familyPageSlugs: any;
+    categoryPageSlugs: any;
+}>;
+export declare const getSubFamilyPageSlugWithDetails: (subFamilyEntry: Entry) => Promise<pageResponse>;
+export declare const updateComponentModelPagesToSubFamilyPage: (subFamilyEntry: Entry) => Promise<Entry>;

package/types/pim/methods/submodels.d.ts

@@ -0,0 +1,2 @@
+import { PaginationResults } from "../../types";
+export declare const importSubModels: (offset?: number, limit?: number) => Promise<PaginationResults>;

package/types/pim/request.d.ts

@@ -0,0 +1,5 @@
+import { AxiosRequestConfig } from "axios";
+export declare let baseRequestConfig: AxiosRequestConfig | null;
+export declare const initBaseRequest: () => void;
+export declare const resetBaseRequest: () => void;
+export declare const getRequest: (url: string, opts?: Record<string, any> & Partial<AxiosRequestConfig>) => Promise<any>;

package/types/resources/AllProducts.d.ts

@@ -0,0 +1,42 @@
+export interface AllProductsEntry {
+    code: string;
+    name: string;
+    webNaming: string;
+    productGroup: ProductGroup;
+    productStatus: ProductStatus;
+    lastModified: LastModified;
+    catalogs?: CatalogsEntity[] | null;
+}
+export interface ProductGroup {
+    code: string;
+    name: string;
+    priority: number;
+}
+export interface ProductStatus {
+    code: string;
+    value_en: string;
+    value_it: string;
+    value_es: string;
+    value_de: string;
+    value_fr: string;
+    value_sv: string;
+    value_no: string;
+    value_da: string;
+    value_ru: string;
+    othersData: OthersData;
+}
+export interface OthersData {
+}
+export interface LastModified {
+    year: number;
+    month: number;
+    dayOfMonth: number;
+    hourOfDay: number;
+    minute: number;
+    second: number;
+}
+export interface CatalogsEntity {
+    catalogCode?: string | null;
+    categoryCode?: string | null;
+    subFamilyCode?: string | null;
+}

package/types/resources/Audit.d.ts

@@ -0,0 +1,24 @@
+declare type AuditCatalog = {
+    where: string;
+    catalogCode?: string;
+    categoryCode?: string;
+    subfamilyCode?: string;
+    models?: string;
+    subModels?: string;
+};
+export interface Audit {
+    what: string;
+    when: When;
+    product: string;
+    upgradeProduct?: string;
+    catalogs: AuditCatalog[];
+}
+export interface When {
+    year: number;
+    month: number;
+    dayOfMonth: number;
+    hourOfDay: number;
+    minute: number;
+    second: number;
+}
+export {};

package/types/resources/CatalogDetails.d.ts

@@ -0,0 +1,46 @@
+export interface CatalogDetails {
+    data: Data;
+    categories?: CategoriesEntity[] | null;
+}
+export interface Data {
+    code: string;
+    value_en: string;
+    value_it: string;
+    value_es: string;
+    value_de: string;
+    value_fr: string;
+    value_sv: string;
+    value_no: string;
+    value_da: string;
+    value_ru: string;
+    othersData: OthersData;
+}
+export interface OthersData {
+}
+export interface CategoriesEntity {
+    data: Data;
+    subfamilies?: (SubfamiliesEntity | null)[] | null;
+}
+export interface SubfamiliesEntity {
+    data: FamilyData;
+    childfamilies?: (ChildfamiliesEntity | null)[] | null;
+    designers?: null[] | null;
+    parentFamily?: FamilyData | null;
+}
+export interface FamilyData {
+    code: string;
+    value_en: string;
+    value_en_US?: string | null;
+    value_it: string;
+    value_es: string;
+    value_de: string;
+    value_fr: string;
+    value_sv: string;
+    value_no: string;
+    value_da: string;
+    value_ru: string;
+    othersData: OthersData;
+}
+export interface ChildfamiliesEntity {
+    data: Data;
+}

package/types/resources/CollectionModels.d.ts

@@ -0,0 +1,41 @@
+export interface CollectionModels {
+    totalCount: number;
+    pageSize: number;
+    pageOffset: number;
+    pagedCollection?: PagedCollectionEntity[] | null;
+}
+export interface PagedCollectionEntity {
+    relatedProducts?: string[] | null;
+    data: Data;
+    priority?: number | null;
+    subFamilyCode: string;
+    productLineCode: string;
+    code: string;
+    othersData: OthersData;
+    description1_en?: string;
+    description1_en_us?: string;
+    description1_it?: string;
+    description1_es?: string;
+    description1_de?: string;
+    description1_fr?: string;
+    description1_sv?: string;
+    description1_no?: string;
+    description1_da?: string;
+    description1_ru?: string;
+}
+export interface Data {
+    code: string;
+    value_en: string;
+    value_en_US: string;
+    value_it: string;
+    value_es: string;
+    value_de: string;
+    value_fr: string;
+    value_sv: string;
+    value_no: string;
+    value_da: string;
+    value_ru: string;
+    othersData: OthersData;
+}
+export interface OthersData {
+}

package/types/resources/CollectionSubFamilies.d.ts

@@ -0,0 +1,45 @@
+export interface CollectionSubFamilies {
+    totalCount: number;
+    pageSize: number;
+    pageOffset: number;
+    pagedCollection?: PagedCollectionEntity[] | null;
+}
+export interface PagedCollectionEntity {
+    data: GenericData;
+    priority?: number;
+    catalogCode: string;
+    categoryCode: string;
+    parentFamily: ParentFamily;
+    designers?: GenericData[] | null;
+    relatedProducts?: string[] | null;
+    description1_en?: string;
+    description1_en_us?: string;
+    description1_it?: string;
+    description1_es?: string;
+    description1_de?: string;
+    description1_fr?: string;
+    description1_sv?: string;
+    description1_no?: string;
+    description1_da?: string;
+    description1_ru?: string;
+}
+export interface GenericData {
+    code: string;
+    value_en: string;
+    value_en_US?: string;
+    value_it: string;
+    value_es: string;
+    value_de: string;
+    value_fr: string;
+    value_sv: string;
+    value_no: string;
+    value_da: string;
+    value_ru: string;
+    othersData: OthersData;
+}
+export interface OthersData {
+}
+export interface ParentFamily {
+    data: GenericData;
+    designers?: GenericData[] | null;
+}

package/types/resources/CollectionSubModels.d.ts

@@ -0,0 +1,36 @@
+export interface CollectionSubModels {
+    totalCount: number;
+    pageSize: number;
+    pageOffset: number;
+    pagedCollection?: PagedCollectionEntity[] | null;
+}
+export interface PagedCollectionEntity {
+    relatedProducts?: string[] | null;
+    data: Data;
+    priority: number;
+    subFamilyCode: string;
+    productLineCode: string;
+    parentModel: ParentModel;
+    code: string;
+    othersData: OthersData;
+}
+export interface Data {
+    code: string;
+    value_en: string;
+    value_en_US: string;
+    value_it: string;
+    value_es: string;
+    value_de: string;
+    value_fr: string;
+    value_sv: string;
+    value_no: string;
+    value_da: string;
+    value_ru: string;
+    othersData: OthersData;
+}
+export interface OthersData {
+}
+export interface ParentModel {
+    code: string;
+    othersData: OthersData;
+}

package/types/resources/DProductSubLine.d.ts

@@ -0,0 +1,34 @@
+export interface DProductSubLine {
+    code: string;
+    image?: null;
+    imageAlternative?: null;
+    value_en: string;
+    value_en_US: string;
+    value_it: string;
+    value_es: string;
+    value_de: string;
+    value_fr: string;
+    value_sv: string;
+    value_no: string;
+    value_da: string;
+    value_ru: string;
+    othersData: OthersData;
+}
+export interface OthersData {
+    productLine: ProductLine;
+}
+export interface ProductLine {
+    code: string;
+    image?: null;
+    imageAlternative?: null;
+    value_en: string;
+    value_it: string;
+    value_es: string;
+    value_de: string;
+    value_fr: string;
+    value_sv: string;
+    value_no: string;
+    value_da: string;
+    value_ru: string;
+    value_en_US?: null;
+}

package/types/resources/FamilyDetails.d.ts

@@ -0,0 +1,31 @@
+export interface FamilyDetails {
+    data: Data;
+    priority?: number;
+    description1_en?: string;
+    description1_en_us?: string;
+    description1_it?: string;
+    description1_es?: string;
+    description1_de?: string;
+    description1_fr?: string;
+    description1_sv?: string;
+    description1_no?: string;
+    description1_da?: string;
+    description1_ru?: string;
+    designers?: null[] | null;
+}
+export interface Data {
+    code: string;
+    value_en: string;
+    value_en_US: string;
+    value_it: string;
+    value_es: string;
+    value_de: string;
+    value_fr: string;
+    value_sv: string;
+    value_no: string;
+    value_da: string;
+    value_ru: string;
+    othersData: OthersData;
+}
+export interface OthersData {
+}