@gofynd/fdk-client-javascript 1.6.4 → 3.0.0-beta.1

package/sdk/platform/Theme/ThemePlatformModel.d.ts

@@ -1,4 +1,99 @@
 export = ThemePlatformModel;
+/**
+ * @typedef MarketplaceTheme
+ * @property {string} [_id] - Theme ID
+ * @property {PaymentInfo} [payment]
+ * @property {ContactInfo} [contact]
+ * @property {string[]} [industry] - Industries the theme is suitable for
+ * @property {boolean} [is_update] - Indicates if the theme is an update
+ * @property {boolean} [is_default] - Indicates if the theme is a default theme
+ * @property {string} [name] - Theme name
+ * @property {string} [tagline] - Theme tagline
+ * @property {string} [description] - Theme description
+ * @property {CatalogSize} [catalog_size]
+ * @property {MarketplaceThemeImages} [images]
+ * @property {CarouselItem[]} [carousel]
+ * @property {string} [src] - Theme source URL
+ * @property {ExploreInfo} [explore]
+ * @property {Feature[]} [features]
+ * @property {Highlight[]} [highlights]
+ * @property {Variation[]} [variations]
+ * @property {Documentation} [documentation]
+ * @property {string} [status] - Theme status
+ * @property {number} [step] - Theme step
+ * @property {Comments} [comments]
+ * @property {Release} [release]
+ * @property {string} [slug] - Theme slug
+ * @property {string} [organization_id] - Organization ID
+ * @property {string} [user_id] - User ID
+ * @property {string} [created_at] - Theme creation timestamp
+ * @property {string} [updated_at] - Theme update timestamp
+ * @property {string} [template_theme_id] - Template theme ID
+ * @property {string} [theme_type] - Theme type
+ */
+/**
+ * @typedef PaymentInfo
+ * @property {boolean} [is_paid] - Indicates if the theme is paid
+ * @property {number} [amount] - Amount of payment
+ */
+/**
+ * @typedef ContactInfo
+ * @property {string[]} [developer_contact] - Developer contact information
+ * @property {string} [seller_contact] - Seller contact information
+ */
+/**
+ * @typedef CatalogSize
+ * @property {number} [min] - Minimum catalog size
+ * @property {number} [max] - Maximum catalog size
+ */
+/**
+ * @typedef MarketplaceThemeImages
+ * @property {string} [desktop] - Desktop theme image URL
+ * @property {string} [mobile] - Mobile theme image URL
+ */
+/**
+ * @typedef CarouselItem
+ * @property {string} [desktop] - Desktop carousel image URL
+ * @property {string} [mobile] - Mobile carousel image URL
+ */
+/**
+ * @typedef ExploreInfo
+ * @property {string} [title] - Explore feature title
+ * @property {string} [description] - Explore feature description
+ */
+/**
+ * @typedef Feature
+ * @property {string} [category] - Feature category
+ * @property {FeatureItem[]} [list]
+ */
+/**
+ * @typedef FeatureItem
+ * @property {string} [label] - Feature properties
+ * @property {string} [description] - Feature description
+ */
+/**
+ * @typedef Highlight
+ * @property {string} [title] - Highlight title
+ * @property {string} [description] - Highlight description
+ * @property {string} [image] - Highlight image URL
+ */
+/**
+ * @typedef Variation
+ * @property {string} [name] - Variation name
+ * @property {string} [color] - Variation color
+ * @property {string} [demo_url] - Variation demo URL
+ * @property {MarketplaceThemeImages} [images]
+ */
+/**
+ * @typedef Documentation
+ * @property {string} [notes] - Documentation notes
+ * @property {string} [url] - Documentation URL
+ */
+/**
+ * @typedef Comments
+ * @property {string} [developer_remark] - Developer remark
+ * @property {string} [reviewer_feedback] - Reviewer feedback
+ */
 /**
  * @typedef GetExtensionSectionRes
  * @property {string} [extension_id]
@@ -46,6 +141,20 @@ export = ThemePlatformModel;
  * @property {string} [updated_at] - The timestamp when the theme was last updated.
  * @property {AppliedThemes[]} [applied_themes]
  */
+/**
+ * @typedef CompanyThemeReqSchema
+ * @property {string} [marketplace_theme_id] - Theme id of the marketplace
+ */
+/**
+ * @typedef CompanyThemeResponse
+ * @property {string} [_id] - The unique identifier for the theme.
+ * @property {string} [name] - The name of the theme.
+ * @property {string} [marketplace_theme_id]
+ * @property {number} [company_id] - The ID of the company that the theme belongs to.
+ * @property {CompanyThemeMeta} [meta]
+ * @property {string} [created_at] - The timestamp when the theme was created.
+ * @property {string} [updated_at] - The timestamp when the theme was last updated.
+ */
 /**
  * @typedef MarketplaceThemeId
  * @property {string} [_id] - The unique identifier for the marketplace theme.
@@ -87,6 +196,7 @@ export = ThemePlatformModel;
  * @property {string} [_id]
  * @property {string} [created_at] - The creation timestamp of the page
  * @property {string} [updated_at] - The last update timestamp of the page
+ * @property {string} [application]
  */
 /**
  * @typedef AvailablePageSectionMetaAttributes
@@ -124,11 +234,13 @@ export = ThemePlatformModel;
  * @property {string} [description]
  * @property {SEOMetaItem[]} [meta_tags]
  * @property {SEOSitemap} [sitemap]
- * @property {SEObreadcrumb[]} [breadcrumb]
+ * @property {SEObreadcrumb[]} [breadcrumbs]
  * @property {string} [_id]
+ * @property {string} [canonical_url]
  */
 /**
  * @typedef AvailablePageSchemaSections
+ * @property {string} [_id] - Unique Id for section.
  * @property {string} [name]
  * @property {string} [label]
  * @property {Object} [props]
@@ -193,7 +305,7 @@ export = ThemePlatformModel;
  */
 /**
  * @typedef FontsSchema
- * @property {FontsSchemaItems} [items]
+ * @property {Object[]} [items]
  * @property {string} [kind]
  */
 /**
@@ -214,6 +326,7 @@ export = ThemePlatformModel;
  * @property {FontsSchemaItemsFiles} [files]
  * @property {string} [category]
  * @property {string} [kind]
+ * @property {string} [menu]
  */
 /**
  * @typedef FontsSchemaItemsFiles
@@ -238,6 +351,7 @@ export = ThemePlatformModel;
  * @property {Object} [styles] - The styles associated with the theme
  * @property {string} [created_at] - The creation timestamp of the theme
  * @property {string} [updated_at] - The last update timestamp of the theme
+ * @property {Object[]} [global_sections]
  * @property {Assets} [assets]
  * @property {SectionItem[]} [available_sections] - Available sections information
  * @property {string} [theme_type]
@@ -245,9 +359,9 @@ export = ThemePlatformModel;
  * @property {string} [src]
  */
 /**
- * @typedef ThemeUpgradable
+ * @typedef ThemeUpgradableResponse
  * @property {boolean} [upgrade] - Indicates if the theme is upgradable or not
- * @property {ThemeVersions} [versions]
+ * @property {Object} [versions]
  * @property {string} [message] - A message describing the theme upgrade status
  */
 /**
@@ -282,7 +396,7 @@ export = ThemePlatformModel;
  * @property {string} current - The current configuration
  * @property {ThemeConfiguration[]} list - A list of configurations
  * @property {GlobalSchema} [global_schema]
- * @property {Preset} [preset]
+ * @property {Object} [preset] - An Object of default theme configurations
  */
 /**
  * @typedef ThemeConfiguration
@@ -392,6 +506,7 @@ export = ThemePlatformModel;
 /**
  * @typedef Prop
  * @property {string} [type] - The type of the property
+ * @property {Option[]} [options]
  * @property {string} [category] - The category of the property
  * @property {string} [value] - The value of the property
  * @property {string} [id] - The ID of the property
@@ -423,6 +538,7 @@ export = ThemePlatformModel;
  * @property {Object[]} [props]
  * @property {Object[]} [blocks] - Blocks
  * @property {string} [name] - Name of the section
+ * @property {SectionPreset} [preset]
  * @property {string} [label] - Label for the section
  */
 /**
@@ -517,7 +633,7 @@ export = ThemePlatformModel;
  * @property {string} [applied_theme] - The version of the applied theme
  */
 /**
- * @typedef DummyTheme
+ * @typedef DummyResponse
  * @property {string} [message]
  */
 /**
@@ -538,6 +654,11 @@ export = ThemePlatformModel;
  * @property {boolean} [is_private] - Whether the theme is private or not
  * @property {CompanyThemeMeta} [meta]
  */
+/**
+ * @typedef Option
+ * @property {string} [text]
+ * @property {string} [value]
+ */
 /**
  * @typedef ActionPage
  * @property {Object} [params] - Parameters that should be considered in path.
@@ -598,8 +719,242 @@ export = ThemePlatformModel;
 declare class ThemePlatformModel {
 }
 declare namespace ThemePlatformModel {
-    export { GetExtensionSectionRes, ExtensionSection, PropExtension, AssetsExtension, ThemeReq, CompanyThemeSchema, MarketplaceThemeId, CompanyThemeMeta, ThemePayment, ThemeImages, AvailablePageSchema, AvailablePageSectionMetaAttributes, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, Action, AvailablePageSeo, AvailablePageSchemaSections, SectionSource, AvailablePagePredicate, AvailablePageScreenPredicate, AvailablePageUserPredicate, AvailablePageRoutePredicate, AvailablePagePlatformPredicate, AvailablePageSchedulePredicate, AllAvailablePageSchema, AddThemeRequestSchema, FontsSchema, BlitzkriegApiErrorSchema, BlitzkriegInternalServerErrorSchema, FontsSchemaItems, FontsSchemaItemsFiles, ThemesSchema, ThemeUpgradable, UpdateThemeNameRequestBody, UpdateThemeRequestBody, Font, FontVariants, FontVariant, Config, ThemeConfiguration, OverlayPopup, DividerStrokeHighlight, UserAlerts, OrderTracking, ThemeConfigListPage, ThemeConfigListPageSettingsProps, CustomConfig, ThemeMeta, Release, Images, CustomProps, GlobalSchema, Prop, Assets, UMDJs, CommonJS, CSS, SectionItem, Preset, Page, Section, Block, Predicate, Screen, ThemeUserSchema, Route, SectionProps, SectionPreset, BlockProps, TextProp, CheckboxProp, RangeProp, ImagePickerProp, UrlProp, ThemeVersions, DummyTheme, AppliedThemes, CompanyPrivateTheme, ActionPage, PageType };
+    export { MarketplaceTheme, PaymentInfo, ContactInfo, CatalogSize, MarketplaceThemeImages, CarouselItem, ExploreInfo, Feature, FeatureItem, Highlight, Variation, Documentation, Comments, GetExtensionSectionRes, ExtensionSection, PropExtension, AssetsExtension, ThemeReq, CompanyThemeSchema, CompanyThemeReqSchema, CompanyThemeResponse, MarketplaceThemeId, CompanyThemeMeta, ThemePayment, ThemeImages, AvailablePageSchema, AvailablePageSectionMetaAttributes, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, Action, AvailablePageSeo, AvailablePageSchemaSections, SectionSource, AvailablePagePredicate, AvailablePageScreenPredicate, AvailablePageUserPredicate, AvailablePageRoutePredicate, AvailablePagePlatformPredicate, AvailablePageSchedulePredicate, AllAvailablePageSchema, AddThemeRequestSchema, FontsSchema, BlitzkriegApiErrorSchema, BlitzkriegInternalServerErrorSchema, FontsSchemaItems, FontsSchemaItemsFiles, ThemesSchema, ThemeUpgradableResponse, UpdateThemeNameRequestBody, UpdateThemeRequestBody, Font, FontVariants, FontVariant, Config, ThemeConfiguration, OverlayPopup, DividerStrokeHighlight, UserAlerts, OrderTracking, ThemeConfigListPage, ThemeConfigListPageSettingsProps, CustomConfig, ThemeMeta, Release, Images, CustomProps, GlobalSchema, Prop, Assets, UMDJs, CommonJS, CSS, SectionItem, Preset, Page, Section, Block, Predicate, Screen, ThemeUserSchema, Route, SectionProps, SectionPreset, BlockProps, TextProp, CheckboxProp, RangeProp, ImagePickerProp, UrlProp, ThemeVersions, DummyResponse, AppliedThemes, CompanyPrivateTheme, Option, ActionPage, PageType };
 }
+/** @returns {MarketplaceTheme} */
+declare function MarketplaceTheme(): MarketplaceTheme;
+type MarketplaceTheme = {
+    /**
+     * - Theme ID
+     */
+    _id?: string;
+    payment?: PaymentInfo;
+    contact?: ContactInfo;
+    /**
+     * - Industries the theme is suitable for
+     */
+    industry?: string[];
+    /**
+     * - Indicates if the theme is an update
+     */
+    is_update?: boolean;
+    /**
+     * - Indicates if the theme is a default theme
+     */
+    is_default?: boolean;
+    /**
+     * - Theme name
+     */
+    name?: string;
+    /**
+     * - Theme tagline
+     */
+    tagline?: string;
+    /**
+     * - Theme description
+     */
+    description?: string;
+    catalog_size?: CatalogSize;
+    images?: MarketplaceThemeImages;
+    carousel?: CarouselItem[];
+    /**
+     * - Theme source URL
+     */
+    src?: string;
+    explore?: ExploreInfo;
+    features?: Feature[];
+    highlights?: Highlight[];
+    variations?: Variation[];
+    documentation?: Documentation;
+    /**
+     * - Theme status
+     */
+    status?: string;
+    /**
+     * - Theme step
+     */
+    step?: number;
+    comments?: Comments;
+    release?: Release;
+    /**
+     * - Theme slug
+     */
+    slug?: string;
+    /**
+     * - Organization ID
+     */
+    organization_id?: string;
+    /**
+     * - User ID
+     */
+    user_id?: string;
+    /**
+     * - Theme creation timestamp
+     */
+    created_at?: string;
+    /**
+     * - Theme update timestamp
+     */
+    updated_at?: string;
+    /**
+     * - Template theme ID
+     */
+    template_theme_id?: string;
+    /**
+     * - Theme type
+     */
+    theme_type?: string;
+};
+/** @returns {PaymentInfo} */
+declare function PaymentInfo(): PaymentInfo;
+type PaymentInfo = {
+    /**
+     * - Indicates if the theme is paid
+     */
+    is_paid?: boolean;
+    /**
+     * - Amount of payment
+     */
+    amount?: number;
+};
+/** @returns {ContactInfo} */
+declare function ContactInfo(): ContactInfo;
+type ContactInfo = {
+    /**
+     * - Developer contact information
+     */
+    developer_contact?: string[];
+    /**
+     * - Seller contact information
+     */
+    seller_contact?: string;
+};
+/** @returns {CatalogSize} */
+declare function CatalogSize(): CatalogSize;
+type CatalogSize = {
+    /**
+     * - Minimum catalog size
+     */
+    min?: number;
+    /**
+     * - Maximum catalog size
+     */
+    max?: number;
+};
+/** @returns {MarketplaceThemeImages} */
+declare function MarketplaceThemeImages(): MarketplaceThemeImages;
+type MarketplaceThemeImages = {
+    /**
+     * - Desktop theme image URL
+     */
+    desktop?: string;
+    /**
+     * - Mobile theme image URL
+     */
+    mobile?: string;
+};
+/** @returns {CarouselItem} */
+declare function CarouselItem(): CarouselItem;
+type CarouselItem = {
+    /**
+     * - Desktop carousel image URL
+     */
+    desktop?: string;
+    /**
+     * - Mobile carousel image URL
+     */
+    mobile?: string;
+};
+/** @returns {ExploreInfo} */
+declare function ExploreInfo(): ExploreInfo;
+type ExploreInfo = {
+    /**
+     * - Explore feature title
+     */
+    title?: string;
+    /**
+     * - Explore feature description
+     */
+    description?: string;
+};
+/** @returns {Feature} */
+declare function Feature(): Feature;
+type Feature = {
+    /**
+     * - Feature category
+     */
+    category?: string;
+    list?: FeatureItem[];
+};
+/** @returns {FeatureItem} */
+declare function FeatureItem(): FeatureItem;
+type FeatureItem = {
+    /**
+     * - Feature properties
+     */
+    label?: string;
+    /**
+     * - Feature description
+     */
+    description?: string;
+};
+/** @returns {Highlight} */
+declare function Highlight(): Highlight;
+type Highlight = {
+    /**
+     * - Highlight title
+     */
+    title?: string;
+    /**
+     * - Highlight description
+     */
+    description?: string;
+    /**
+     * - Highlight image URL
+     */
+    image?: string;
+};
+/** @returns {Variation} */
+declare function Variation(): Variation;
+type Variation = {
+    /**
+     * - Variation name
+     */
+    name?: string;
+    /**
+     * - Variation color
+     */
+    color?: string;
+    /**
+     * - Variation demo URL
+     */
+    demo_url?: string;
+    images?: MarketplaceThemeImages;
+};
+/** @returns {Documentation} */
+declare function Documentation(): Documentation;
+type Documentation = {
+    /**
+     * - Documentation notes
+     */
+    notes?: string;
+    /**
+     * - Documentation URL
+     */
+    url?: string;
+};
+/** @returns {Comments} */
+declare function Comments(): Comments;
+type Comments = {
+    /**
+     * - Developer remark
+     */
+    developer_remark?: string;
+    /**
+     * - Reviewer feedback
+     */
+    reviewer_feedback?: string;
+};
 /** @returns {GetExtensionSectionRes} */
 declare function GetExtensionSectionRes(): GetExtensionSectionRes;
 type GetExtensionSectionRes = {
@@ -671,6 +1026,40 @@ type CompanyThemeSchema = {
     updated_at?: string;
     applied_themes?: AppliedThemes[];
 };
+/** @returns {CompanyThemeReqSchema} */
+declare function CompanyThemeReqSchema(): CompanyThemeReqSchema;
+type CompanyThemeReqSchema = {
+    /**
+     * - Theme id of the marketplace
+     */
+    marketplace_theme_id?: string;
+};
+/** @returns {CompanyThemeResponse} */
+declare function CompanyThemeResponse(): CompanyThemeResponse;
+type CompanyThemeResponse = {
+    /**
+     * - The unique identifier for the theme.
+     */
+    _id?: string;
+    /**
+     * - The name of the theme.
+     */
+    name?: string;
+    marketplace_theme_id?: string;
+    /**
+     * - The ID of the company that the theme belongs to.
+     */
+    company_id?: number;
+    meta?: CompanyThemeMeta;
+    /**
+     * - The timestamp when the theme was created.
+     */
+    created_at?: string;
+    /**
+     * - The timestamp when the theme was last updated.
+     */
+    updated_at?: string;
+};
 /** @returns {MarketplaceThemeId} */
 declare function MarketplaceThemeId(): MarketplaceThemeId;
 type MarketplaceThemeId = {
@@ -756,6 +1145,7 @@ type AvailablePageSchema = {
      * - The last update timestamp of the page
      */
     updated_at?: string;
+    application?: string;
 };
 /** @returns {AvailablePageSectionMetaAttributes} */
 declare function AvailablePageSectionMetaAttributes(): AvailablePageSectionMetaAttributes;
@@ -803,12 +1193,17 @@ type AvailablePageSeo = {
     description?: string;
     meta_tags?: SEOMetaItem[];
     sitemap?: SEOSitemap;
-    breadcrumb?: SEObreadcrumb[];
+    breadcrumbs?: SEObreadcrumb[];
     _id?: string;
+    canonical_url?: string;
 };
 /** @returns {AvailablePageSchemaSections} */
 declare function AvailablePageSchemaSections(): AvailablePageSchemaSections;
 type AvailablePageSchemaSections = {
+    /**
+     * - Unique Id for section.
+     */
+    _id?: string;
     name?: string;
     label?: string;
     props?: any;
@@ -904,7 +1299,7 @@ type AddThemeRequestSchema = {
 /** @returns {FontsSchema} */
 declare function FontsSchema(): FontsSchema;
 type FontsSchema = {
-    items?: FontsSchemaItems;
+    items?: any[];
     kind?: string;
 };
 /** @returns {BlitzkriegApiErrorSchema} */
@@ -928,6 +1323,7 @@ type FontsSchemaItems = {
     files?: FontsSchemaItemsFiles;
     category?: string;
     kind?: string;
+    menu?: string;
 };
 /** @returns {FontsSchemaItemsFiles} */
 declare function FontsSchemaItemsFiles(): FontsSchemaItemsFiles;
@@ -990,6 +1386,7 @@ type ThemesSchema = {
      * - The last update timestamp of the theme
      */
     updated_at?: string;
+    global_sections?: any[];
     assets?: Assets;
     /**
      * - Available sections information
@@ -1002,14 +1399,14 @@ type ThemesSchema = {
     company_id?: number;
     src?: string;
 };
-/** @returns {ThemeUpgradable} */
-declare function ThemeUpgradable(): ThemeUpgradable;
-type ThemeUpgradable = {
+/** @returns {ThemeUpgradableResponse} */
+declare function ThemeUpgradableResponse(): ThemeUpgradableResponse;
+type ThemeUpgradableResponse = {
     /**
      * - Indicates if the theme is upgradable or not
      */
     upgrade?: boolean;
-    versions?: ThemeVersions;
+    versions?: any;
     /**
      * - A message describing the theme upgrade status
      */
@@ -1071,7 +1468,10 @@ type Config = {
      */
     list: ThemeConfiguration[];
     global_schema?: GlobalSchema;
-    preset?: Preset;
+    /**
+     * - An Object of default theme configurations
+     */
+    preset?: any;
 };
 /** @returns {ThemeConfiguration} */
 declare function ThemeConfiguration(): ThemeConfiguration;
@@ -1321,6 +1721,7 @@ type Prop = {
      * - The type of the property
      */
     type?: string;
+    options?: Option[];
     /**
      * - The category of the property
      */
@@ -1381,6 +1782,7 @@ type SectionItem = {
      * - Name of the section
      */
     name?: string;
+    preset?: SectionPreset;
     /**
      * - Label for the section
      */
@@ -1563,9 +1965,9 @@ type ThemeVersions = {
      */
     applied_theme?: string;
 };
-/** @returns {DummyTheme} */
-declare function DummyTheme(): DummyTheme;
-type DummyTheme = {
+/** @returns {DummyResponse} */
+declare function DummyResponse(): DummyResponse;
+type DummyResponse = {
     message?: string;
 };
 /** @returns {AppliedThemes} */
@@ -1621,6 +2023,12 @@ type CompanyPrivateTheme = {
     is_private?: boolean;
     meta?: CompanyThemeMeta;
 };
+/** @returns {Option} */
+declare function Option(): Option;
+type Option = {
+    text?: string;
+    value?: string;
+};
 /** @returns {ActionPage} */
 declare function ActionPage(): ActionPage;
 type ActionPage = {