@gofynd/fdk-client-javascript 0.1.36 → 1.0.0

package/sdk/platform/Share/SharePlatformModel.js

@@ -0,0 +1,170 @@
+const Joi = require("joi");
+
+class ShareModel {
+  static RedirectDevice() {
+    return Joi.object({
+      link: Joi.string().allow(""),
+
+      type: Joi.string().allow(""),
+    });
+  }
+
+  static WebRedirect() {
+    return Joi.object({
+      link: Joi.string().allow(""),
+
+      type: Joi.string().allow(""),
+    });
+  }
+
+  static Redirects() {
+    return Joi.object({
+      ios: ShareModel.RedirectDevice(),
+
+      android: ShareModel.RedirectDevice(),
+
+      web: ShareModel.WebRedirect(),
+
+      force_web: Joi.boolean(),
+    });
+  }
+
+  static CampaignShortLink() {
+    return Joi.object({
+      source: Joi.string().allow(""),
+
+      medium: Joi.string().allow(""),
+    });
+  }
+
+  static Attribution() {
+    return Joi.object({
+      campaign_cookie_expiry: Joi.string().allow(""),
+    });
+  }
+
+  static SocialMediaTags() {
+    return Joi.object({
+      title: Joi.string().allow(""),
+
+      description: Joi.string().allow(""),
+
+      image: Joi.string().allow(""),
+    });
+  }
+
+  static ShortLinkReq() {
+    return Joi.object({
+      title: Joi.string().allow("").required(),
+
+      url: Joi.string().allow("").required(),
+
+      hash: Joi.string().allow(""),
+
+      active: Joi.boolean(),
+
+      expire_at: Joi.string().allow(""),
+
+      enable_tracking: Joi.boolean(),
+
+      personalized: Joi.boolean(),
+
+      campaign: ShareModel.CampaignShortLink(),
+
+      redirects: ShareModel.Redirects(),
+
+      attribution: ShareModel.Attribution(),
+
+      social_media_tags: ShareModel.SocialMediaTags(),
+
+      count: Joi.number(),
+    });
+  }
+
+  static UrlInfo() {
+    return Joi.object({
+      original: Joi.string().allow(""),
+
+      short: Joi.string().allow(""),
+
+      hash: Joi.string().allow(""),
+    });
+  }
+
+  static ShortLinkRes() {
+    return Joi.object({
+      title: Joi.string().allow(""),
+
+      url: ShareModel.UrlInfo(),
+
+      created_by: Joi.string().allow(""),
+
+      app_redirect: Joi.boolean(),
+
+      fallback: Joi.string().allow(""),
+
+      active: Joi.boolean(),
+
+      _id: Joi.string().allow(""),
+
+      enable_tracking: Joi.boolean(),
+
+      expire_at: Joi.string().allow(""),
+
+      application: Joi.string().allow(""),
+
+      user_id: Joi.string().allow(""),
+
+      created_at: Joi.string().allow(""),
+
+      meta: Joi.any(),
+
+      updated_at: Joi.string().allow(""),
+
+      personalized: Joi.boolean(),
+
+      campaign: ShareModel.CampaignShortLink(),
+
+      redirects: ShareModel.Redirects(),
+
+      attribution: ShareModel.Attribution(),
+
+      social_media_tags: ShareModel.SocialMediaTags(),
+
+      count: Joi.number(),
+    });
+  }
+
+  static Page() {
+    return Joi.object({
+      item_total: Joi.number(),
+
+      next_id: Joi.string().allow(""),
+
+      has_previous: Joi.boolean(),
+
+      has_next: Joi.boolean(),
+
+      current: Joi.number(),
+
+      type: Joi.string().allow("").required(),
+
+      size: Joi.number(),
+    });
+  }
+
+  static ShortLinkList() {
+    return Joi.object({
+      items: Joi.array().items(ShareModel.ShortLinkRes()),
+
+      page: ShareModel.Page(),
+    });
+  }
+
+  static ErrorRes() {
+    return Joi.object({
+      message: Joi.string().allow(""),
+    });
+  }
+}
+module.exports = ShareModel;

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

@@ -0,0 +1,238 @@
+export = Theme;
+declare class Theme {
+    constructor(config: any, applicationId: any);
+    config: any;
+    applicationId: any;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.themeId - ID of the theme to be retrieved
+     * @summary: Get all pages of a theme
+     * @description: Use this API to retrieve all the available pages of a theme by its ID.
+     */
+    getAllPages({ themeId }?: {
+        themeId: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.themeId - ID of the theme
+     * @param {AvailablePageSchema} arg.body
+     * @summary: Create a page
+     * @description: Use this API to create a page for a theme by its ID.
+     */
+    createPage({ themeId, body }?: {
+        themeId: string;
+        body: AvailablePageSchema;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.themeId - ID of the theme to be retrieved
+     * @param {AllAvailablePageSchema} arg.body
+     * @summary: Update multiple pages of a theme
+     * @description: Use this API to update multiple pages of a theme by its ID.
+     */
+    updateMultiplePages({ themeId, body }?: {
+        themeId: string;
+        body: AllAvailablePageSchema;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.themeId - ID of the theme to be retrieved
+     * @param {string} arg.pageValue - Value of the page to be retrieved
+     * @summary: Get page of a theme
+     * @description: Use this API to retrieve a page of a theme.
+     */
+    getPage({ themeId, pageValue }?: {
+        themeId: string;
+        pageValue: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.themeId - ID of the theme
+     * @param {string} arg.pageValue - Value of the page to be updated
+     * @param {AvailablePageSchema} arg.body
+     * @summary: Updates a page
+     * @description: Use this API to update a page for a theme by its ID.
+     */
+    updatePage({ themeId, pageValue, body }?: {
+        themeId: string;
+        pageValue: string;
+        body: AvailablePageSchema;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.themeId - ID of the theme
+     * @param {string} arg.pageValue - Value of the page to be updated
+     * @summary: Deletes a page
+     * @description: Use this API to delete a page for a theme by its ID and page_value.
+     */
+    deletePage({ themeId, pageValue }?: {
+        themeId: string;
+        pageValue: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageSize] - The number of items to retrieve in each
+     *   page. Default value is 10.
+     * @param {number} [arg.pageNo] - The page number to navigate through the
+     *   given set of results. Default value is 1.
+     * @summary: Get a list of themes from the theme library
+     * @description: Theme library is a personalized collection of themes that are chosen and added from the available themes. Use this API to fetch a list of themes from the library along with their configuration details.
+     */
+    getThemeLibrary({ pageSize, pageNo }?: {
+        pageSize?: number;
+        pageNo?: number;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {AddThemeRequestSchema} arg.body
+     * @summary: Add a theme to the theme library
+     * @description: Theme library is a personalized collection of themes that are chosen and added from the available themes. Use this API to choose a theme and add it to the theme library.
+     */
+    addToThemeLibrary({ body }?: {
+        body: AddThemeRequestSchema;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {AddThemeRequestSchema} arg.body
+     * @summary: Apply a theme
+     * @description: Use this API to apply a theme to the website.
+     */
+    applyTheme({ body }?: {
+        body: AddThemeRequestSchema;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.themeId - Theme ID
+     * @summary: Checks if theme is upgradable
+     * @description: There's always a possibility that new features get added to a theme. Use this API to check if the applied theme has an upgrade available.
+     */
+    isUpgradable({ themeId }?: {
+        themeId: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.themeId - ID allotted to the theme.
+     * @summary: Upgrade a theme
+     * @description: Use this API to upgrade the current theme to its latest version.
+     */
+    upgradeTheme({ themeId }?: {
+        themeId: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {number} [arg.pageSize] - The number of items to retrieve in each
+     *   page. Default value is 10.
+     * @param {number} [arg.pageNo] - The page number to navigate through the
+     *   given set of results. Default value is 1.
+     * @summary: Get all public themes
+     * @description: Use this API to get a list of free themes that you can apply to your website.
+     */
+    getPublicThemes({ pageSize, pageNo }?: {
+        pageSize?: number;
+        pageNo?: number;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {ThemesSchema} arg.body
+     * @summary: Create a new theme
+     * @description: Themes improve the look and appearance of a website. Use this API to create a theme.
+     */
+    createTheme({ body }?: {
+        body: ThemesSchema;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @summary: Get the applied theme
+     * @description: Use this API to retrieve the theme that is currently applied to the website along with its details.
+     */
+    getAppliedTheme({}?: any): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @summary: Get all the supported fonts in a theme
+     * @description: Font is a collection of characters with a similar design. Use this API to retrieve a list of website fonts.
+     */
+    getFonts({}?: any): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.themeId - ID allotted to the theme.
+     * @summary: Gets theme by id
+     * @description: Use this API to retrieve the details of a specific theme by using its ID.
+     */
+    getThemeById({ themeId }?: {
+        themeId: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.themeId - ID allotted to the theme.
+     * @param {ThemesSchema} arg.body
+     * @summary: Update a theme
+     * @description: Use this API to edit an existing theme. You can customize the website font, sections, images, styles, and many more.
+     */
+    updateTheme({ themeId, body }?: {
+        themeId: string;
+        body: ThemesSchema;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.themeId - ID allotted to the theme.
+     * @summary: Delete a theme
+     * @description: Use this API to delete a theme from the theme library.
+     */
+    deleteTheme({ themeId }?: {
+        themeId: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.themeId - ID allotted to the theme.
+     * @summary: Get a theme preview
+     * @description: A theme can be previewed before applying it. Use this API to retrieve the theme preview by using its ID.
+     */
+    getThemeForPreview({ themeId }?: {
+        themeId: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.themeId - ID allotted to the theme.
+     * @summary: Publish a theme
+     * @description: Use this API to publish a theme that is either newly created or edited.
+     */
+    publishTheme({ themeId }?: {
+        themeId: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.themeId - ID allotted to the theme.
+     * @summary: Unpublish a theme
+     * @description: Use this API to remove an existing theme from the list of available themes.
+     */
+    unpublishTheme({ themeId }?: {
+        themeId: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.themeId - ID allotted to the theme.
+     * @summary: Archive a theme
+     * @description: Use this API to store an existing theme but not delete it so that it can be used in future if required.
+     */
+    archiveTheme({ themeId }?: {
+        themeId: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.themeId - ID allotted to the theme.
+     * @summary: Unarchive a theme
+     * @description: Use this API to restore an archived theme and bring it back for editing or publishing.
+     */
+    unarchiveTheme({ themeId }?: {
+        themeId: string;
+    }): Promise<any>;
+    /**
+     * @param {Object} arg - Arg object.
+     * @param {string} arg.themeId - ID allotted to the theme.
+     * @summary: Fetch last modified timestamp
+     * @description: Use this API to fetch Last-Modified timestamp in header metadata.
+     */
+    getThemeLastModified({ themeId }?: {
+        themeId: string;
+    }): Promise<any>;
+}