@gofynd/fdk-client-javascript 1.4.6 → 1.4.8-beta.2

package/sdk/platform/Theme/ThemePlatformApplicationClient.js

@@ -788,6 +788,88 @@ class Theme {
     return response;
   }
 
+  /**
+   * @param {ThemePlatformApplicationValidator.GetExtensionSectionsParam} arg
+   *   - Arg object
+   *
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+   * @param {import("../PlatformAPIClient").Options} - Options
+   * @returns {Promise<ThemePlatformModel.GetExtensionSectionRes[]>} - Success response
+   * @name getExtensionSections
+   * @summary: Get extension sections
+   * @description: Retrieve the list of extension sections for a given application in the specified company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/theme/getExtensionSections/).
+   */
+  async getExtensionSections(
+    { type, companyMode, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
+    const {
+      error,
+    } = ThemePlatformApplicationValidator.getExtensionSections().validate(
+      {
+        type,
+        companyMode,
+      },
+      { abortEarly: false, allowUnknown: true }
+    );
+    if (error) {
+      return Promise.reject(new FDKClientValidationError(error));
+    }
+
+    // Showing warrnings if extra unknown parameters are found
+    const {
+      error: warrning,
+    } = ThemePlatformApplicationValidator.getExtensionSections().validate(
+      {
+        type,
+        companyMode,
+      },
+      { abortEarly: false, allowUnknown: false }
+    );
+    if (warrning) {
+      Logger({
+        level: "WARN",
+        message: `Parameter Validation warrnings for platform > Theme > getExtensionSections \n ${warrning}`,
+      });
+    }
+
+    const query_params = {};
+    query_params["type"] = type;
+    query_params["company_mode"] = companyMode;
+
+    const response = await PlatformAPIClient.execute(
+      this.config,
+      "get",
+      `/service/platform/theme/v1.0/company/${this.config.companyId}/application/${this.applicationId}/extension-section`,
+      query_params,
+      undefined,
+      requestHeaders,
+      { responseHeaders }
+    );
+
+    let responseData = response;
+    if (responseHeaders) {
+      responseData = response[0];
+    }
+
+    const { error: res_error } = Joi.array()
+      .items(ThemePlatformModel.GetExtensionSectionRes())
+      .validate(responseData, { abortEarly: false, allowUnknown: true });
+
+    if (res_error) {
+      if (this.config.options.strictResponseCheck === true) {
+        return Promise.reject(new FDKResponseValidationError(res_error));
+      } else {
+        Logger({
+          level: "WARN",
+          message: `Response Validation Warnings for platform > Theme > getExtensionSections \n ${res_error}`,
+        });
+      }
+    }
+
+    return response;
+  }
+
   /**
    * @param {ThemePlatformApplicationValidator.GetFontsParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`

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

@@ -32,6 +32,11 @@ export = ThemePlatformApplicationValidator;
 /** @typedef GetApplicationThemesParam */
 /** @typedef GetApplicationThemesCountParam */
 /** @typedef GetAppliedThemeParam */
+/**
+ * @typedef GetExtensionSectionsParam
+ * @property {string} [type] - The type of the theme
+ * @property {string} [companyMode] - The mode of the company
+ */
 /** @typedef GetFontsParam */
 /**
  * @typedef GetPageParam
@@ -100,6 +105,8 @@ declare class ThemePlatformApplicationValidator {
     static getApplicationThemesCount(): any;
     /** @returns {GetAppliedThemeParam} */
     static getAppliedTheme(): any;
+    /** @returns {GetExtensionSectionsParam} */
+    static getExtensionSections(): GetExtensionSectionsParam;
     /** @returns {GetFontsParam} */
     static getFonts(): any;
     /** @returns {GetPageParam} */
@@ -124,7 +131,7 @@ declare class ThemePlatformApplicationValidator {
     static upgradeTheme(): UpgradeThemeParam;
 }
 declare namespace ThemePlatformApplicationValidator {
-    export { AddThemeToApplicationParam, ApplyThemeParam, CreatePageParam, DeletePageParam, DeleteThemeParam, DuplicateThemeParam, GetAllPagesParam, GetApplicationThemesParam, GetApplicationThemesCountParam, GetAppliedThemeParam, GetFontsParam, GetPageParam, GetThemeByIdParam, GetThemeForPreviewParam, GetThemeLastModifiedParam, IsUpgradableParam, UpdateMultiplePagesParam, UpdatePageParam, UpdateThemeParam, UpdateThemeNameParam, UpgradeThemeParam };
+    export { AddThemeToApplicationParam, ApplyThemeParam, CreatePageParam, DeletePageParam, DeleteThemeParam, DuplicateThemeParam, GetAllPagesParam, GetApplicationThemesParam, GetApplicationThemesCountParam, GetAppliedThemeParam, GetExtensionSectionsParam, GetFontsParam, GetPageParam, GetThemeByIdParam, GetThemeForPreviewParam, GetThemeLastModifiedParam, IsUpgradableParam, UpdateMultiplePagesParam, UpdatePageParam, UpdateThemeParam, UpdateThemeNameParam, UpgradeThemeParam };
 }
 type AddThemeToApplicationParam = {
     body: ThemePlatformModel.ThemeReq;
@@ -170,6 +177,16 @@ type GetAllPagesParam = {
      */
     themeId: string;
 };
+type GetExtensionSectionsParam = {
+    /**
+     * - The type of the theme
+     */
+    type?: string;
+    /**
+     * - The mode of the company
+     */
+    companyMode?: string;
+};
 type GetPageParam = {
     /**
      * - ID of the theme to be retrieved

package/sdk/platform/Theme/ThemePlatformApplicationValidator.js

@@ -45,6 +45,12 @@ const ThemePlatformModel = require("./ThemePlatformModel");
 
 /** @typedef GetAppliedThemeParam */
 
+/**
+ * @typedef GetExtensionSectionsParam
+ * @property {string} [type] - The type of the theme
+ * @property {string} [companyMode] - The mode of the company
+ */
+
 /** @typedef GetFontsParam */
 
 /**
@@ -170,6 +176,14 @@ class ThemePlatformApplicationValidator {
     return Joi.object({}).required();
   }
 
+  /** @returns {GetExtensionSectionsParam} */
+  static getExtensionSections() {
+    return Joi.object({
+      type: Joi.string().allow(""),
+      companyMode: Joi.string().allow(""),
+    }).required();
+  }
+
   /** @returns {GetFontsParam} */
   static getFonts() {
     return Joi.object({}).required();

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

@@ -1,4 +1,35 @@
 export = ThemePlatformModel;
+/**
+ * @typedef GetExtensionSectionRes
+ * @property {string} [extension_id]
+ * @property {string} [bundle_name]
+ * @property {string} [organization_id]
+ * @property {ExtensionSection[]} [sections]
+ * @property {AssetsExtension} [assets]
+ * @property {string} [status]
+ * @property {string} [type]
+ * @property {string} [created_at]
+ * @property {string} [updated_at]
+ */
+/**
+ * @typedef ExtensionSection
+ * @property {string} [label]
+ * @property {string} [name]
+ * @property {PropExtension[]} [props]
+ * @property {Object[]} [blocks]
+ */
+/**
+ * @typedef PropExtension
+ * @property {string} [id]
+ * @property {string} [label]
+ * @property {string} [type]
+ * @property {string} [info]
+ */
+/**
+ * @typedef AssetsExtension
+ * @property {string} [js]
+ * @property {string} [css]
+ */
 /**
  * @typedef ThemeReq
  * @property {string} [marketplace_theme_id] - The ID of the marketplace theme
@@ -557,8 +588,43 @@ export = ThemePlatformModel;
 declare class ThemePlatformModel {
 }
 declare namespace ThemePlatformModel {
-    export { ThemeReq, CompanyThemeSchema, MarketplaceThemeId, CompanyThemeMeta, ThemePayment, ThemeImages, AvailablePageSchema, AvailablePageSectionMetaAttributes, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, Action, AvailablePageSeo, AvailablePageSchemaSections, 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, ActionPage, PageType };
+    export { GetExtensionSectionRes, ExtensionSection, PropExtension, AssetsExtension, ThemeReq, CompanyThemeSchema, MarketplaceThemeId, CompanyThemeMeta, ThemePayment, ThemeImages, AvailablePageSchema, AvailablePageSectionMetaAttributes, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, Action, AvailablePageSeo, AvailablePageSchemaSections, 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, ActionPage, PageType };
 }
+/** @returns {GetExtensionSectionRes} */
+declare function GetExtensionSectionRes(): GetExtensionSectionRes;
+type GetExtensionSectionRes = {
+    extension_id?: string;
+    bundle_name?: string;
+    organization_id?: string;
+    sections?: ExtensionSection[];
+    assets?: AssetsExtension;
+    status?: string;
+    type?: string;
+    created_at?: string;
+    updated_at?: string;
+};
+/** @returns {ExtensionSection} */
+declare function ExtensionSection(): ExtensionSection;
+type ExtensionSection = {
+    label?: string;
+    name?: string;
+    props?: PropExtension[];
+    blocks?: any[];
+};
+/** @returns {PropExtension} */
+declare function PropExtension(): PropExtension;
+type PropExtension = {
+    id?: string;
+    label?: string;
+    type?: string;
+    info?: string;
+};
+/** @returns {AssetsExtension} */
+declare function AssetsExtension(): AssetsExtension;
+type AssetsExtension = {
+    js?: string;
+    css?: string;
+};
 /** @returns {ThemeReq} */
 declare function ThemeReq(): ThemeReq;
 type ThemeReq = {

package/sdk/platform/Theme/ThemePlatformModel.js

@@ -1,5 +1,40 @@
 const Joi = require("joi");
 
+/**
+ * @typedef GetExtensionSectionRes
+ * @property {string} [extension_id]
+ * @property {string} [bundle_name]
+ * @property {string} [organization_id]
+ * @property {ExtensionSection[]} [sections]
+ * @property {AssetsExtension} [assets]
+ * @property {string} [status]
+ * @property {string} [type]
+ * @property {string} [created_at]
+ * @property {string} [updated_at]
+ */
+
+/**
+ * @typedef ExtensionSection
+ * @property {string} [label]
+ * @property {string} [name]
+ * @property {PropExtension[]} [props]
+ * @property {Object[]} [blocks]
+ */
+
+/**
+ * @typedef PropExtension
+ * @property {string} [id]
+ * @property {string} [label]
+ * @property {string} [type]
+ * @property {string} [info]
+ */
+
+/**
+ * @typedef AssetsExtension
+ * @property {string} [js]
+ * @property {string} [css]
+ */
+
 /**
  * @typedef ThemeReq
  * @property {string} [marketplace_theme_id] - The ID of the marketplace theme
@@ -633,6 +668,49 @@ const Joi = require("joi");
  */
 
 class ThemePlatformModel {
+  /** @returns {GetExtensionSectionRes} */
+  static GetExtensionSectionRes() {
+    return Joi.object({
+      extension_id: Joi.string().allow(""),
+      bundle_name: Joi.string().allow(""),
+      organization_id: Joi.string().allow(""),
+      sections: Joi.array().items(ThemePlatformModel.ExtensionSection()),
+      assets: ThemePlatformModel.AssetsExtension(),
+      status: Joi.string().allow(""),
+      type: Joi.string().allow(""),
+      created_at: Joi.string().allow(""),
+      updated_at: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {ExtensionSection} */
+  static ExtensionSection() {
+    return Joi.object({
+      label: Joi.string().allow(""),
+      name: Joi.string().allow(""),
+      props: Joi.array().items(ThemePlatformModel.PropExtension()),
+      blocks: Joi.array().items(Joi.any()),
+    });
+  }
+
+  /** @returns {PropExtension} */
+  static PropExtension() {
+    return Joi.object({
+      id: Joi.string().allow(""),
+      label: Joi.string().allow(""),
+      type: Joi.string().allow(""),
+      info: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {AssetsExtension} */
+  static AssetsExtension() {
+    return Joi.object({
+      js: Joi.string().allow(""),
+      css: Joi.string().allow(""),
+    });
+  }
+
   /** @returns {ThemeReq} */
   static ThemeReq() {
     return Joi.object({

package/sdk/platform/Webhook/WebhookPlatformClient.d.ts

@@ -43,16 +43,6 @@ declare class Webhook {
      * @description: Retrieve reports on the delivery status of events. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getDeliveryReports/).
      */
     getDeliveryReports({ body, requestHeaders }?: WebhookPlatformValidator.GetDeliveryReportsParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.EventProcessReports>;
-    /**
-     * @param {WebhookPlatformValidator.GetEventCountsParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<WebhookPlatformModel.RetryCountResponse>} - Success response
-     * @name getEventCounts
-     * @summary: Get event counts
-     * @description: Retrieve the counts of events based on their status. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getEventCounts/).
-     */
-    getEventCounts({ body, requestHeaders }?: WebhookPlatformValidator.GetEventCountsParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.RetryCountResponse>;
     /**
      * @param {WebhookPlatformValidator.GetHistoricalReportsParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -63,16 +53,6 @@ declare class Webhook {
      * @description: Retrieve historical reports of webhook events. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getHistoricalReports/).
      */
     getHistoricalReports({ body, requestHeaders }?: WebhookPlatformValidator.GetHistoricalReportsParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.HistoryResponse>;
-    /**
-     * @param {WebhookPlatformValidator.GetManualRetryStatusParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<WebhookPlatformModel.RetryStatusResponse>} - Success response
-     * @name getManualRetryStatus
-     * @summary: Get manual retry status
-     * @description: Check the status of a manual retry operation. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getManualRetryStatus/).
-     */
-    getManualRetryStatus({ requestHeaders }?: any, { responseHeaders }?: object): Promise<WebhookPlatformModel.RetryStatusResponse>;
     /**
      * @param {WebhookPlatformValidator.GetReportFiltersParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -113,26 +93,6 @@ declare class Webhook {
      * @description: Retrieve subscribers associated with a specific extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/getSubscribersByExtensionId/).
      */
     getSubscribersByExtensionId({ extensionId, pageNo, pageSize, requestHeaders }?: WebhookPlatformValidator.GetSubscribersByExtensionIdParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigList>;
-    /**
-     * @param {WebhookPlatformValidator.ManualRetryCancelParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<string>} - Success response
-     * @name manualRetryCancel
-     * @summary: Manual retry cancellation
-     * @description: Cancel a manual retry operation for a failed event. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/manualRetryCancel/).
-     */
-    manualRetryCancel({ requestHeaders }?: any, { responseHeaders }?: object): Promise<string>;
-    /**
-     * @param {WebhookPlatformValidator.ManualRetryOfFailedEventParam} arg - Arg object
-     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-     * @param {import("../PlatformAPIClient").Options} - Options
-     * @returns {Promise<WebhookPlatformModel.RetrySuccessResponse>} - Success response
-     * @name manualRetryOfFailedEvent
-     * @summary: Manual retry of failed event
-     * @description: Trigger a manual retry for an event that failed to deliver. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/manualRetryOfFailedEvent/).
-     */
-    manualRetryOfFailedEvent({ body, requestHeaders }?: WebhookPlatformValidator.ManualRetryOfFailedEventParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.RetrySuccessResponse>;
     /**
      * @param {WebhookPlatformValidator.PingWebhookParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -154,6 +114,18 @@ declare class Webhook {
      * @description: Add a subscriber to receive events of a specific type. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/registerSubscriberToEvent/).
      */
     registerSubscriberToEvent({ body, requestHeaders }?: WebhookPlatformValidator.RegisterSubscriberToEventParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigResponse>;
+    /**
+     * @param {WebhookPlatformValidator.RegisterSubscriberToEventV2Param} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<WebhookPlatformModel.SubscriberConfigResponse>} -
+     *   Success response
+     * @name registerSubscriberToEventV2
+     * @summary: Register Subscriber.
+     * @description: Register Subscriber.
+     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/registerSubscriberToEventV2/).
+     */
+    registerSubscriberToEventV2({ body, requestHeaders }?: WebhookPlatformValidator.RegisterSubscriberToEventV2Param, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigResponse>;
     /**
      * @param {WebhookPlatformValidator.UpdateSubscriberConfigParam} arg - Arg object
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -165,6 +137,18 @@ declare class Webhook {
      * @description: Modify and update subscriber configuration settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/updateSubscriberConfig/).
      */
     updateSubscriberConfig({ body, requestHeaders }?: WebhookPlatformValidator.UpdateSubscriberConfigParam, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigResponse>;
+    /**
+     * @param {WebhookPlatformValidator.UpdateSubscriberV2Param} arg - Arg object
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../PlatformAPIClient").Options} - Options
+     * @returns {Promise<WebhookPlatformModel.SubscriberConfigResponse>} -
+     *   Success response
+     * @name updateSubscriberV2
+     * @summary: Update Subscriber.
+     * @description: Update Subscriber.
+     *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/webhook/updateSubscriberV2/).
+     */
+    updateSubscriberV2({ body, requestHeaders }?: WebhookPlatformValidator.UpdateSubscriberV2Param, { responseHeaders }?: object): Promise<WebhookPlatformModel.SubscriberConfigResponse>;
 }
 import WebhookPlatformValidator = require("./WebhookPlatformValidator");
 import WebhookPlatformModel = require("./WebhookPlatformModel");