@gofynd/fdk-client-javascript 3.1.0-beta.1 → 3.2.0

package/sdk/public/Content/ContentPublicModel.d.ts

@@ -267,23 +267,6 @@ export = ContentPublicModel;
  * @typedef CredentialsSchema
  * @property {CredentialSchema[]} [items]
  */
-/**
- * @typedef SDKLinksResponseSchema
- * @property {SDKLinkObjectSchema[]} [readmes]
- */
-/**
- * @typedef SDKLinkObjectSchema
- * @property {string} [owner]
- * @property {string} [repo]
- * @property {string} [path]
- * @property {string} [image]
- * @property {string} [name]
- * @property {string} [type]
- */
-/**
- * @typedef SDKbyTypeResponseSchema
- * @property {string} [readme_content]
- */
 /**
  * @typedef ContentAPIError
  * @property {string} [message]
@@ -295,10 +278,57 @@ export = ContentPublicModel;
  * @property {string} [stack_trace]
  * @property {Object} [meta]
  */
+/**
+ * @typedef Language
+ * @property {string} [_id] - Unique identifier for the language entry in the
+ *   system database.
+ * @property {string} locale - Standard language code following ISO 639-1 format
+ *   for language identification.
+ * @property {string} direction - Text direction specification for proper
+ *   content rendering in the language.
+ * @property {string} name - Full name of the language in English for easy
+ *   reference and display at the merchant panel.
+ * @property {string} [display_name] - Translated name of the language in
+ *   English for easy reference and display at the website.
+ */
+/**
+ * @typedef Error
+ * @property {string} [error] - Detailed error message explaining the nature of
+ *   the failure or invalid request.
+ */
+/**
+ * @typedef TranslatableResource
+ * @property {string} [_id] - Unique identifier for the translatable resource in
+ *   the system.
+ * @property {string} type - Categorization of the resource indicating its
+ *   context and ownership level
+ * @property {string} name - Primary identifier or title of the resource in its
+ *   default language.
+ * @property {string} description - Detailed explanation of the resource's
+ *   purpose and content scope.
+ * @property {Meta} meta
+ */
+/**
+ * @typedef Meta
+ * @property {string} [created_by] - ID of the user who initially created the resource.
+ * @property {string} [updated_by] - ID of the user who last modified the resource.
+ * @property {string} [created_at] - Timestamp indicating when the resource was
+ *   first created.
+ * @property {string} [updated_at] - Timestamp indicating when the resource was
+ *   last modified.
+ */
+/**
+ * @typedef ResourceTranslation
+ * @property {string} [_id] - Unique identifier for the translation entry in the system.
+ * @property {string} [locale] - Language code indicating the target language of
+ *   the translation.
+ * @property {Object} [value] - Contains the translated content with flexible
+ *   schema based on resource type.
+ */
 declare class ContentPublicModel {
 }
 declare namespace ContentPublicModel {
-    export { BasicDetailsPayloadSchema, WhatsNew, Features, BusinessAccount, SellerSupport, MenuSchema, MenusSchema, MenuTypeSchema, CompanyLevelMenuItemSchema, ApplicationLevelMenuItemSchema, VisibleOnSchema, SalesChannelSchema, OtherSellerSchema, FooterContentSchema, AnalyticsTagsSchema, CustomPageBySlugSchema, ItemSchema, CreateCustomPageSeoSchema, RawHtmlContentSchema, FooterSchema, HomePageContentSchema, NavItemSchema, NavbarSchema, MediaSchema, CreatedBySchema, PricingBannerSchema, SdkReadmeSchema, TagsSchema, CustomItemSchema, PageSchema, UserSchema, CredentialSchema, ConfigurationSchema, CredentialsSchema, SDKLinksResponseSchema, SDKLinkObjectSchema, SDKbyTypeResponseSchema, ContentAPIError };
+    export { BasicDetailsPayloadSchema, WhatsNew, Features, BusinessAccount, SellerSupport, MenuSchema, MenusSchema, MenuTypeSchema, CompanyLevelMenuItemSchema, ApplicationLevelMenuItemSchema, VisibleOnSchema, SalesChannelSchema, OtherSellerSchema, FooterContentSchema, AnalyticsTagsSchema, CustomPageBySlugSchema, ItemSchema, CreateCustomPageSeoSchema, RawHtmlContentSchema, FooterSchema, HomePageContentSchema, NavItemSchema, NavbarSchema, MediaSchema, CreatedBySchema, PricingBannerSchema, SdkReadmeSchema, TagsSchema, CustomItemSchema, PageSchema, UserSchema, CredentialSchema, ConfigurationSchema, CredentialsSchema, ContentAPIError, Language, Error, TranslatableResource, Meta, ResourceTranslation };
 }
 /** @returns {BasicDetailsPayloadSchema} */
 declare function BasicDetailsPayloadSchema(): BasicDetailsPayloadSchema;
@@ -602,26 +632,6 @@ declare function CredentialsSchema(): CredentialsSchema;
 type CredentialsSchema = {
     items?: CredentialSchema[];
 };
-/** @returns {SDKLinksResponseSchema} */
-declare function SDKLinksResponseSchema(): SDKLinksResponseSchema;
-type SDKLinksResponseSchema = {
-    readmes?: SDKLinkObjectSchema[];
-};
-/** @returns {SDKLinkObjectSchema} */
-declare function SDKLinkObjectSchema(): SDKLinkObjectSchema;
-type SDKLinkObjectSchema = {
-    owner?: string;
-    repo?: string;
-    path?: string;
-    image?: string;
-    name?: string;
-    type?: string;
-};
-/** @returns {SDKbyTypeResponseSchema} */
-declare function SDKbyTypeResponseSchema(): SDKbyTypeResponseSchema;
-type SDKbyTypeResponseSchema = {
-    readme_content?: string;
-};
 /** @returns {ContentAPIError} */
 declare function ContentAPIError(): ContentAPIError;
 type ContentAPIError = {
@@ -634,3 +644,106 @@ type ContentAPIError = {
     stack_trace?: string;
     meta?: any;
 };
+/** @returns {Language} */
+declare function Language(): Language;
+type Language = {
+    /**
+     * - Unique identifier for the language entry in the
+     * system database.
+     */
+    _id?: string;
+    /**
+     * - Standard language code following ISO 639-1 format
+     * for language identification.
+     */
+    locale: string;
+    /**
+     * - Text direction specification for proper
+     * content rendering in the language.
+     */
+    direction: string;
+    /**
+     * - Full name of the language in English for easy
+     * reference and display at the merchant panel.
+     */
+    name: string;
+    /**
+     * - Translated name of the language in
+     * English for easy reference and display at the website.
+     */
+    display_name?: string;
+};
+/** @returns {Error} */
+declare function Error(): Error;
+type Error = {
+    /**
+     * - Detailed error message explaining the nature of
+     * the failure or invalid request.
+     */
+    error?: string;
+};
+/** @returns {TranslatableResource} */
+declare function TranslatableResource(): TranslatableResource;
+type TranslatableResource = {
+    /**
+     * - Unique identifier for the translatable resource in
+     * the system.
+     */
+    _id?: string;
+    /**
+     * - Categorization of the resource indicating its
+     * context and ownership level
+     */
+    type: string;
+    /**
+     * - Primary identifier or title of the resource in its
+     * default language.
+     */
+    name: string;
+    /**
+     * - Detailed explanation of the resource's
+     * purpose and content scope.
+     */
+    description: string;
+    meta: Meta;
+};
+/** @returns {Meta} */
+declare function Meta(): Meta;
+type Meta = {
+    /**
+     * - ID of the user who initially created the resource.
+     */
+    created_by?: string;
+    /**
+     * - ID of the user who last modified the resource.
+     */
+    updated_by?: string;
+    /**
+     * - Timestamp indicating when the resource was
+     * first created.
+     */
+    created_at?: string;
+    /**
+     * - Timestamp indicating when the resource was
+     * last modified.
+     */
+    updated_at?: string;
+};
+/** @returns {ResourceTranslation} */
+declare function ResourceTranslation(): ResourceTranslation;
+type ResourceTranslation = {
+    /**
+     * - Unique identifier for the translation entry in the system.
+     */
+    _id?: string;
+    /**
+     * - Language code indicating the target language of
+     * the translation.
+     */
+    locale?: string;
+    /**
+     * - Contains the translated content with flexible
+     * schema based on resource type.
+     */
+    value?: any;
+};

package/sdk/public/Content/ContentPublicModel.js

@@ -302,26 +302,6 @@ const Joi = require("joi");
  * @property {CredentialSchema[]} [items]
  */
 
-/**
- * @typedef SDKLinksResponseSchema
- * @property {SDKLinkObjectSchema[]} [readmes]
- */
-
-/**
- * @typedef SDKLinkObjectSchema
- * @property {string} [owner]
- * @property {string} [repo]
- * @property {string} [path]
- * @property {string} [image]
- * @property {string} [name]
- * @property {string} [type]
- */
-
-/**
- * @typedef SDKbyTypeResponseSchema
- * @property {string} [readme_content]
- */
-
 /**
  * @typedef ContentAPIError
  * @property {string} [message]
@@ -334,6 +314,58 @@ const Joi = require("joi");
  * @property {Object} [meta]
  */
 
+/**
+ * @typedef Language
+ * @property {string} [_id] - Unique identifier for the language entry in the
+ *   system database.
+ * @property {string} locale - Standard language code following ISO 639-1 format
+ *   for language identification.
+ * @property {string} direction - Text direction specification for proper
+ *   content rendering in the language.
+ * @property {string} name - Full name of the language in English for easy
+ *   reference and display at the merchant panel.
+ * @property {string} [display_name] - Translated name of the language in
+ *   English for easy reference and display at the website.
+ */
+
+/**
+ * @typedef Error
+ * @property {string} [error] - Detailed error message explaining the nature of
+ *   the failure or invalid request.
+ */
+
+/**
+ * @typedef TranslatableResource
+ * @property {string} [_id] - Unique identifier for the translatable resource in
+ *   the system.
+ * @property {string} type - Categorization of the resource indicating its
+ *   context and ownership level
+ * @property {string} name - Primary identifier or title of the resource in its
+ *   default language.
+ * @property {string} description - Detailed explanation of the resource's
+ *   purpose and content scope.
+ * @property {Meta} meta
+ */
+
+/**
+ * @typedef Meta
+ * @property {string} [created_by] - ID of the user who initially created the resource.
+ * @property {string} [updated_by] - ID of the user who last modified the resource.
+ * @property {string} [created_at] - Timestamp indicating when the resource was
+ *   first created.
+ * @property {string} [updated_at] - Timestamp indicating when the resource was
+ *   last modified.
+ */
+
+/**
+ * @typedef ResourceTranslation
+ * @property {string} [_id] - Unique identifier for the translation entry in the system.
+ * @property {string} [locale] - Language code indicating the target language of
+ *   the translation.
+ * @property {Object} [value] - Contains the translated content with flexible
+ *   schema based on resource type.
+ */
+
 class ContentPublicModel {
   /** @returns {BasicDetailsPayloadSchema} */
   static BasicDetailsPayloadSchema() {
@@ -709,43 +741,65 @@ class ContentPublicModel {
     });
   }
 
-  /** @returns {SDKLinksResponseSchema} */
-  static SDKLinksResponseSchema() {
+  /** @returns {ContentAPIError} */
+  static ContentAPIError() {
     return Joi.object({
-      readmes: Joi.array().items(ContentPublicModel.SDKLinkObjectSchema()),
+      message: Joi.string().allow(""),
+      status: Joi.number(),
+      code: Joi.string().allow(""),
+      exception: Joi.string().allow(""),
+      info: Joi.string().allow(""),
+      request_id: Joi.string().allow(""),
+      stack_trace: Joi.string().allow(""),
+      meta: Joi.object().pattern(/\S/, Joi.any()),
     });
   }
 
-  /** @returns {SDKLinkObjectSchema} */
-  static SDKLinkObjectSchema() {
+  /** @returns {Language} */
+  static Language() {
     return Joi.object({
-      owner: Joi.string().allow(""),
-      repo: Joi.string().allow(""),
-      path: Joi.string().allow(""),
-      image: Joi.string().allow(""),
-      name: Joi.string().allow(""),
-      type: Joi.string().allow(""),
+      _id: Joi.string().allow(""),
+      locale: Joi.string().allow("").required(),
+      direction: Joi.string().allow("").required(),
+      name: Joi.string().allow("").required(),
+      display_name: Joi.string().allow(""),
     });
   }
 
-  /** @returns {SDKbyTypeResponseSchema} */
-  static SDKbyTypeResponseSchema() {
+  /** @returns {Error} */
+  static Error() {
     return Joi.object({
-      readme_content: Joi.string().allow(""),
+      error: Joi.string().allow(""),
     });
   }
 
-  /** @returns {ContentAPIError} */
-  static ContentAPIError() {
+  /** @returns {TranslatableResource} */
+  static TranslatableResource() {
     return Joi.object({
-      message: Joi.string().allow(""),
-      status: Joi.number(),
-      code: Joi.string().allow(""),
-      exception: Joi.string().allow(""),
-      info: Joi.string().allow(""),
-      request_id: Joi.string().allow(""),
-      stack_trace: Joi.string().allow(""),
-      meta: Joi.any(),
+      _id: Joi.string().allow(""),
+      type: Joi.string().allow("").required(),
+      name: Joi.string().allow("").required(),
+      description: Joi.string().allow("").required(),
+      meta: ContentPublicModel.Meta().required(),
+    });
+  }
+
+  /** @returns {Meta} */
+  static Meta() {
+    return Joi.object({
+      created_by: Joi.string().allow(""),
+      updated_by: Joi.string().allow(""),
+      created_at: Joi.string().allow(""),
+      updated_at: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {ResourceTranslation} */
+  static ResourceTranslation() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+      locale: Joi.string().allow(""),
+      value: Joi.object().pattern(/\S/, Joi.any()),
     });
   }
 }

package/sdk/public/Content/ContentPublicValidator.d.ts

@@ -1,5 +1,7 @@
 export = ContentPublicValidator;
+/** @typedef GetAllLanguagesParam */
 /** @typedef GetAllTagsParam */
+/** @typedef GetAllTranslatableResourcesParam */
 /** @typedef GetAnalyticsTagsParam */
 /** @typedef GetBasicDetailsParam */
 /**
@@ -16,6 +18,10 @@ export = ContentPublicValidator;
  * @typedef GetHomePageContentParam
  * @property {string} pageType - The type of the page (e.g., pricing).
  */
+/**
+ * @typedef GetLanguageByLocaleParam
+ * @property {string} locale
+ */
 /** @typedef GetMenuContentParam */
 /**
  * @typedef GetMenuContentByTypeParam
@@ -23,14 +29,13 @@ export = ContentPublicValidator;
  */
 /** @typedef GetNavbarParam */
 /** @typedef GetPricingBannerParam */
-/** @typedef GetSDKDocumentationParam */
-/**
- * @typedef GetSDKDocumentationByTypeParam
- * @property {string} type - Type of SDK
- */
 declare class ContentPublicValidator {
+    /** @returns {GetAllLanguagesParam} */
+    static getAllLanguages(): any;
     /** @returns {GetAllTagsParam} */
     static getAllTags(): any;
+    /** @returns {GetAllTranslatableResourcesParam} */
+    static getAllTranslatableResources(): any;
     /** @returns {GetAnalyticsTagsParam} */
     static getAnalyticsTags(): any;
     /** @returns {GetBasicDetailsParam} */
@@ -43,6 +48,8 @@ declare class ContentPublicValidator {
     static getFooterContent(): any;
     /** @returns {GetHomePageContentParam} */
     static getHomePageContent(): GetHomePageContentParam;
+    /** @returns {GetLanguageByLocaleParam} */
+    static getLanguageByLocale(): GetLanguageByLocaleParam;
     /** @returns {GetMenuContentParam} */
     static getMenuContent(): any;
     /** @returns {GetMenuContentByTypeParam} */
@@ -51,13 +58,9 @@ declare class ContentPublicValidator {
     static getNavbar(): any;
     /** @returns {GetPricingBannerParam} */
     static getPricingBanner(): any;
-    /** @returns {GetSDKDocumentationParam} */
-    static getSDKDocumentation(): any;
-    /** @returns {GetSDKDocumentationByTypeParam} */
-    static getSDKDocumentationByType(): GetSDKDocumentationByTypeParam;
 }
 declare namespace ContentPublicValidator {
-    export { GetAllTagsParam, GetAnalyticsTagsParam, GetBasicDetailsParam, GetCredentialsByEntityParam, GetCustomPageParam, GetFooterContentParam, GetHomePageContentParam, GetMenuContentParam, GetMenuContentByTypeParam, GetNavbarParam, GetPricingBannerParam, GetSDKDocumentationParam, GetSDKDocumentationByTypeParam };
+    export { GetAllLanguagesParam, GetAllTagsParam, GetAllTranslatableResourcesParam, GetAnalyticsTagsParam, GetBasicDetailsParam, GetCredentialsByEntityParam, GetCustomPageParam, GetFooterContentParam, GetHomePageContentParam, GetLanguageByLocaleParam, GetMenuContentParam, GetMenuContentByTypeParam, GetNavbarParam, GetPricingBannerParam };
 }
 type GetCredentialsByEntityParam = {
     /**
@@ -78,23 +81,21 @@ type GetHomePageContentParam = {
      */
     pageType: string;
 };
+type GetLanguageByLocaleParam = {
+    locale: string;
+};
 type GetMenuContentByTypeParam = {
     /**
      * - Type param is type of device
      */
     type: string;
 };
-type GetSDKDocumentationByTypeParam = {
-    /**
-     * - Type of SDK
-     */
-    type: string;
-};
+type GetAllLanguagesParam = any;
 type GetAllTagsParam = any;
+type GetAllTranslatableResourcesParam = any;
 type GetAnalyticsTagsParam = any;
 type GetBasicDetailsParam = any;
 type GetFooterContentParam = any;
 type GetMenuContentParam = any;
 type GetNavbarParam = any;
 type GetPricingBannerParam = any;
-type GetSDKDocumentationParam = any;

package/sdk/public/Content/ContentPublicValidator.js

@@ -2,8 +2,12 @@ const Joi = require("joi");
 
 const ContentPublicModel = require("./ContentPublicModel");
 
+/** @typedef GetAllLanguagesParam */
+
 /** @typedef GetAllTagsParam */
 
+/** @typedef GetAllTranslatableResourcesParam */
+
 /** @typedef GetAnalyticsTagsParam */
 
 /** @typedef GetBasicDetailsParam */
@@ -26,6 +30,11 @@ const ContentPublicModel = require("./ContentPublicModel");
  * @property {string} pageType - The type of the page (e.g., pricing).
  */
 
+/**
+ * @typedef GetLanguageByLocaleParam
+ * @property {string} locale
+ */
+
 /** @typedef GetMenuContentParam */
 
 /**
@@ -37,19 +46,22 @@ const ContentPublicModel = require("./ContentPublicModel");
 
 /** @typedef GetPricingBannerParam */
 
-/** @typedef GetSDKDocumentationParam */
-
-/**
- * @typedef GetSDKDocumentationByTypeParam
- * @property {string} type - Type of SDK
- */
-
 class ContentPublicValidator {
+  /** @returns {GetAllLanguagesParam} */
+  static getAllLanguages() {
+    return Joi.object({});
+  }
+
   /** @returns {GetAllTagsParam} */
   static getAllTags() {
     return Joi.object({});
   }
 
+  /** @returns {GetAllTranslatableResourcesParam} */
+  static getAllTranslatableResources() {
+    return Joi.object({});
+  }
+
   /** @returns {GetAnalyticsTagsParam} */
   static getAnalyticsTags() {
     return Joi.object({});
@@ -86,6 +98,13 @@ class ContentPublicValidator {
     }).required();
   }
 
+  /** @returns {GetLanguageByLocaleParam} */
+  static getLanguageByLocale() {
+    return Joi.object({
+      locale: Joi.string().allow("").required(),
+    }).required();
+  }
+
   /** @returns {GetMenuContentParam} */
   static getMenuContent() {
     return Joi.object({});
@@ -107,18 +126,6 @@ class ContentPublicValidator {
   static getPricingBanner() {
     return Joi.object({});
   }
-
-  /** @returns {GetSDKDocumentationParam} */
-  static getSDKDocumentation() {
-    return Joi.object({});
-  }
-
-  /** @returns {GetSDKDocumentationByTypeParam} */
-  static getSDKDocumentationByType() {
-    return Joi.object({
-      type: Joi.string().allow("").required(),
-    }).required();
-  }
 }
 
 module.exports = ContentPublicValidator;

package/sdk/public/Partner/PartnerPublicClient.d.ts

@@ -16,7 +16,7 @@ declare class Partner {
      * @summary: Get panel extension details
      * @description: Retrieve detailed information about panel extensions in the public server setup. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/public/partner/getPanelExtensionDetails/).
      */
-    getPanelExtensionDetails({ slug, requestHeaders }?: PartnerPublicValidator.GetPanelExtensionDetailsParam, { responseHeaders }?: object): Promise<PartnerPublicModel.ExtensionUsingSlug>;
+    getPanelExtensionDetails({ slug, requestHeaders }?: PartnerPublicValidator.GetPanelExtensionDetailsParam, { responseHeaders }?: object, ...args: any[]): Promise<PartnerPublicModel.ExtensionUsingSlug>;
 }
 import PartnerPublicValidator = require("./PartnerPublicValidator");
 import PartnerPublicModel = require("./PartnerPublicModel");

package/sdk/public/Partner/PartnerPublicClient.js

@@ -6,6 +6,7 @@ const {
 const PublicAPIClient = require("../PublicAPIClient");
 const constructUrl = require("../constructUrl");
 const Paginator = require("../../common/Paginator");
+const { validateRequiredParams } = require("../../common/Validator");
 
 const PartnerPublicValidator = require("./PartnerPublicValidator");
 const PartnerPublicModel = require("./PartnerPublicModel");
@@ -48,18 +49,12 @@ class Partner {
     { slug, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    let invalidInput = [];
-
-    if (!slug) {
-      invalidInput.push({
-        message: `The 'slug' field is required.`,
-        path: ["slug"],
+    const errors = validateRequiredParams(arguments[0], ["slug"]);
+    if (errors.length > 0) {
+      const error = new FDKClientValidationError({
+        message: "Missing required field",
+        details: errors,
       });
-    }
-    if (invalidInput.length) {
-      const error = new Error();
-      error.message = "Missing required field";
-      error.details = invalidInput;
       return Promise.reject(new FDKClientValidationError(error));
     }