@gofynd/fdk-client-javascript 1.1.2 → 1.1.4

package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts

@@ -311,6 +311,8 @@ declare class Catalog {
      *   **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
      * @param {boolean} [arg.filters] - Pass `filters` parameter to fetch the
      *   filter details. This flag is used to fetch all filters
+     * @param {boolean} [arg.isDependent] - This query parameter is used to get
+     *   the dependent products in the listing.
      * @param {string} [arg.sortOn] - The order to sort the list of products on.
      *   The supported sort parameters are popularity, price, redemption and
      *   discount in either ascending or descending order. See the supported
@@ -328,11 +330,12 @@ declare class Catalog {
      * @summary: List the products
      * @description: List all the products associated with a brand, collection or category in a requested sort order. The API additionally supports arbitrary search queries that may refer the name of any product, brand, category or collection. If successful, returns a paginated list of products specified in `ApplicationProductListingResponse`
      */
-    getAppicationProducts({ q, f, c, filters, sortOn, pageId, pageSize, pageNo, pageType, itemIds, }?: {
+    getAppicationProducts({ q, f, c, filters, isDependent, sortOn, pageId, pageSize, pageNo, pageType, itemIds, }?: {
         q?: string;
         f?: string;
         c?: string;
         filters?: boolean;
+        isDependent?: boolean;
         sortOn?: string;
         pageId?: string;
         pageSize?: number;
@@ -357,6 +360,8 @@ declare class Catalog {
      *   **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
      * @param {boolean} [arg.filters] - Pass `filters` parameter to fetch the
      *   filter details. This flag is used to fetch all filters
+     * @param {boolean} [arg.isDependent] - This query parameter is used to get
+     *   the dependent products in the listing.
      * @param {string} [arg.sortOn] - The order to sort the list of products on.
      *   The supported sort parameters are popularity, price, redemption and
      *   discount in either ascending or descending order. See the supported
@@ -367,13 +372,14 @@ declare class Catalog {
      * @summary: List the products
      * @description: List all the products associated with a brand, collection or category in a requested sort order. The API additionally supports arbitrary search queries that may refer the name of any product, brand, category or collection. If successful, returns a paginated list of products specified in `ApplicationProductListingResponse`
      */
-    getAppicationProductsPaginator({ companyId, applicationId, q, f, c, filters, sortOn, pageSize, itemIds, }?: {
+    getAppicationProductsPaginator({ companyId, applicationId, q, f, c, filters, isDependent, sortOn, pageSize, itemIds, }?: {
         companyId: string;
         applicationId: string;
         q?: string;
         f?: string;
         c?: string;
         filters?: boolean;
+        isDependent?: boolean;
         sortOn?: string;
         pageSize?: number;
         itemIds?: number[];

package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js

@@ -1421,6 +1421,8 @@ class Catalog {
    *   **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
    * @param {boolean} [arg.filters] - Pass `filters` parameter to fetch the
    *   filter details. This flag is used to fetch all filters
+   * @param {boolean} [arg.isDependent] - This query parameter is used to get
+   *   the dependent products in the listing.
    * @param {string} [arg.sortOn] - The order to sort the list of products on.
    *   The supported sort parameters are popularity, price, redemption and
    *   discount in either ascending or descending order. See the supported
@@ -1443,6 +1445,7 @@ class Catalog {
     f,
     c,
     filters,
+    isDependent,
     sortOn,
     pageId,
     pageSize,
@@ -1456,6 +1459,7 @@ class Catalog {
         f,
         c,
         filters,
+        isDependent,
         sortOn,
         pageId,
         pageSize,
@@ -1478,6 +1482,7 @@ class Catalog {
         f,
         c,
         filters,
+        isDependent,
         sortOn,
         pageId,
         pageSize,
@@ -1500,6 +1505,7 @@ class Catalog {
     query_params["f"] = f;
     query_params["c"] = c;
     query_params["filters"] = filters;
+    query_params["is_dependent"] = isDependent;
     query_params["sort_on"] = sortOn;
     query_params["page_id"] = pageId;
     query_params["page_size"] = pageSize;
@@ -1550,6 +1556,8 @@ class Catalog {
    *   **?c=brand:in:voi-jeans|and:::category:nin:t-shirts|shirts**
    * @param {boolean} [arg.filters] - Pass `filters` parameter to fetch the
    *   filter details. This flag is used to fetch all filters
+   * @param {boolean} [arg.isDependent] - This query parameter is used to get
+   *   the dependent products in the listing.
    * @param {string} [arg.sortOn] - The order to sort the list of products on.
    *   The supported sort parameters are popularity, price, redemption and
    *   discount in either ascending or descending order. See the supported
@@ -1567,6 +1575,7 @@ class Catalog {
     f,
     c,
     filters,
+    isDependent,
     sortOn,
     pageSize,
     itemIds,
@@ -1583,6 +1592,7 @@ class Catalog {
         f: f,
         c: c,
         filters: filters,
+        isDependent: isDependent,
         sortOn: sortOn,
         pageId: pageId,
         pageSize: pageSize,

package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js

@@ -150,6 +150,7 @@ class CatalogValidator {
       f: Joi.string().allow(""),
       c: Joi.string().allow(""),
       filters: Joi.boolean(),
+      isDependent: Joi.boolean(),
       sortOn: Joi.string().allow(""),
       pageId: Joi.string().allow(""),
       pageSize: Joi.number(),

package/sdk/platform/Catalog/CatalogPlatformClient.js

@@ -1443,7 +1443,7 @@ class Catalog {
     const response = await PlatformAPIClient.execute(
       this.config,
       "delete",
-      `/service/platform/catalog/v2.0/company/${this.config.companyId}/products/${itemId}/inventory/${sellerIdentifier}/`,
+      `/service/platform/catalog/v2.0/company/${this.config.companyId}/products/${itemId}/inventory/${sellerIdentifier}`,
       query_params,
       body,
       xHeaders
@@ -5128,7 +5128,7 @@ class Catalog {
     const response = await PlatformAPIClient.execute(
       this.config,
       "post",
-      `/service/platform/catalog/v2.0/company/${this.config.companyId}/products/${itemId}/inventory/${sellerIdentifier}/`,
+      `/service/platform/catalog/v2.0/company/${this.config.companyId}/products/${itemId}/inventory/${sellerIdentifier}`,
       query_params,
       body,
       xHeaders

package/sdk/platform/Catalog/CatalogPlatformModel.d.ts

@@ -33,6 +33,7 @@ declare class CatalogModel {
     static AttributeMasterSerializer(): any;
     static AttributeSchemaRange(): any;
     static AutocompleteAction(): any;
+    static AutoCompleteMedia(): any;
     static AutocompletePageAction(): any;
     static AutocompleteResult(): any;
     static BannerImage(): any;

package/sdk/platform/Catalog/CatalogPlatformModel.js

@@ -262,6 +262,7 @@ class CatalogModel {
       description: Joi.string().allow(""),
       details: CatalogModel.AttributeMasterDetails().required(),
       enabled_for_end_consumer: Joi.boolean(),
+      example: Joi.string().allow(""),
       filters: CatalogModel.AttributeMasterFilter().required(),
       is_nested: Joi.boolean(),
       logo: Joi.string().allow(""),
@@ -290,6 +291,13 @@ class CatalogModel {
       type: Joi.string().allow(""),
     });
   }
+  static AutoCompleteMedia() {
+    return Joi.object({
+      aspect_ratio: Joi.string().allow(""),
+      type: Joi.string().allow(""),
+      url: Joi.string().allow(""),
+    });
+  }
   static AutocompletePageAction() {
     return Joi.object({
       params: Joi.any(),
@@ -303,7 +311,7 @@ class CatalogModel {
       _custom_json: Joi.any(),
       action: CatalogModel.AutocompleteAction(),
       display: Joi.string().allow(""),
-      logo: CatalogModel.Media(),
+      logo: CatalogModel.AutoCompleteMedia(),
     });
   }
   static BannerImage() {
@@ -326,7 +334,7 @@ class CatalogModel {
       banners: CatalogModel.ImageUrls(),
       departments: Joi.array().items(Joi.string().allow("")),
       discount: Joi.string().allow(""),
-      logo: CatalogModel.Media(),
+      logo: CatalogModel.Media2(),
       name: Joi.string().allow(""),
       slug: Joi.string().allow(""),
       uid: Joi.number(),
@@ -472,7 +480,7 @@ class CatalogModel {
       is_active: Joi.boolean().required(),
       level: Joi.number().required(),
       marketplaces: CatalogModel.CategoryMapping(),
-      media: CatalogModel.Media2(),
+      media: CatalogModel.Media1(),
       modified_by: Joi.any(),
       modified_on: Joi.string().allow(""),
       name: Joi.string().allow("").required(),
@@ -525,7 +533,7 @@ class CatalogModel {
       is_active: Joi.boolean().required(),
       level: Joi.number().required(),
       marketplaces: CatalogModel.CategoryMapping(),
-      media: CatalogModel.Media2(),
+      media: CatalogModel.Media1(),
       name: Joi.string().allow("").required(),
       priority: Joi.number(),
       slug: Joi.string().allow(""),
@@ -602,7 +610,7 @@ class CatalogModel {
       cron: Joi.any(),
       description: Joi.string().allow(""),
       is_active: Joi.boolean(),
-      logo: CatalogModel.Media1(),
+      logo: CatalogModel.Media(),
       meta: Joi.any(),
       name: Joi.string().allow(""),
       priority: Joi.number(),
@@ -756,6 +764,7 @@ class CatalogModel {
       condition: Joi.string().allow(""),
       map: Joi.any(),
       map_values: Joi.array().items(Joi.any()),
+      priority: Joi.array().items(Joi.string().allow("")),
       sort: Joi.string().allow(""),
       value: Joi.string().allow(""),
     });
@@ -909,7 +918,7 @@ class CatalogModel {
   }
   static Department() {
     return Joi.object({
-      logo: CatalogModel.Media(),
+      logo: CatalogModel.Media2(),
       name: Joi.string().allow(""),
       priority_order: Joi.number(),
       slug: Joi.string().allow(""),
@@ -1140,7 +1149,7 @@ class CatalogModel {
       cron: Joi.any(),
       description: Joi.string().allow(""),
       is_active: Joi.boolean(),
-      logo: CatalogModel.Media1(),
+      logo: CatalogModel.Media(),
       meta: Joi.any(),
       name: Joi.string().allow(""),
       priority: Joi.number(),
@@ -1179,15 +1188,15 @@ class CatalogModel {
       addresses: Joi.array().items(CatalogModel.GetAddressSerializer()),
       business_type: Joi.string().allow(""),
       company_type: Joi.string().allow(""),
-      created_by: CatalogModel.UserSerializer2(),
+      created_by: CatalogModel.UserSerializer1(),
       created_on: Joi.string().allow(""),
-      modified_by: CatalogModel.UserSerializer2(),
+      modified_by: CatalogModel.UserSerializer1(),
       modified_on: Joi.string().allow(""),
       name: Joi.string().allow(""),
       reject_reason: Joi.string().allow(""),
       stage: Joi.string().allow(""),
       uid: Joi.number(),
-      verified_by: CatalogModel.UserSerializer2(),
+      verified_by: CatalogModel.UserSerializer1(),
       verified_on: Joi.string().allow(""),
     });
   }
@@ -1270,14 +1279,14 @@ class CatalogModel {
       code: Joi.string().allow("").required(),
       company: CatalogModel.GetCompanySerializer(),
       contact_numbers: Joi.array().items(CatalogModel.SellerPhoneNumber()),
-      created_by: CatalogModel.UserSerializer1(),
+      created_by: CatalogModel.UserSerializer2(),
       created_on: Joi.string().allow(""),
       display_name: Joi.string().allow("").required(),
       documents: Joi.array().items(CatalogModel.Document()),
       gst_credentials: CatalogModel.InvoiceDetailsSerializer(),
       integration_type: CatalogModel.LocationIntegrationType(),
       manager: CatalogModel.LocationManagerSerializer(),
-      modified_by: CatalogModel.UserSerializer1(),
+      modified_by: CatalogModel.UserSerializer2(),
       modified_on: Joi.string().allow(""),
       name: Joi.string().allow("").required(),
       notification_emails: Joi.array().items(Joi.string().allow("")),
@@ -1287,7 +1296,7 @@ class CatalogModel {
       store_type: Joi.string().allow(""),
       timing: Joi.array().items(CatalogModel.LocationDayWiseSerializer()),
       uid: Joi.number(),
-      verified_by: CatalogModel.UserSerializer1(),
+      verified_by: CatalogModel.UserSerializer2(),
       verified_on: Joi.string().allow(""),
       warnings: Joi.any(),
     });
@@ -1892,26 +1901,26 @@ class CatalogModel {
     });
   }
   static Media() {
-    return Joi.object({
-      aspect_ratio: Joi.string().allow(""),
-      type: Joi.string().allow(""),
-      url: Joi.string().allow(""),
-    });
-  }
-  static Media1() {
     return Joi.object({
       meta: Joi.any(),
       type: Joi.string().allow(""),
       url: Joi.string().allow("").required(),
     });
   }
-  static Media2() {
+  static Media1() {
     return Joi.object({
       landscape: Joi.string().allow("").required(),
       logo: Joi.string().allow("").required(),
       portrait: Joi.string().allow("").required(),
     });
   }
+  static Media2() {
+    return Joi.object({
+      aspect_ratio: Joi.string().allow(""),
+      type: Joi.string().allow(""),
+      url: Joi.string().allow(""),
+    });
+  }
   static Meta() {
     return Joi.object({
       headers: Joi.any(),
@@ -1964,7 +1973,7 @@ class CatalogModel {
   }
   static NetQuantity() {
     return Joi.object({
-      unit: Joi.any(),
+      unit: Joi.string().allow(""),
       value: Joi.number(),
     });
   }
@@ -2131,7 +2140,7 @@ class CatalogModel {
       item_code: Joi.string().allow(""),
       item_type: Joi.string().allow(""),
       l3_mapping: Joi.array().items(Joi.string().allow("")),
-      media: Joi.array().items(CatalogModel.Media1()),
+      media: Joi.array().items(CatalogModel.Media()),
       modified_by: Joi.any(),
       modified_on: Joi.string().allow(""),
       moq: Joi.any(),
@@ -2172,13 +2181,14 @@ class CatalogModel {
   static ProductBrand() {
     return Joi.object({
       action: CatalogModel.Action(),
-      logo: CatalogModel.Media1(),
+      logo: CatalogModel.Media(),
       name: Joi.string().allow(""),
       uid: Joi.number(),
     });
   }
   static ProductBulkAssets() {
     return Joi.object({
+      batch_id: Joi.string().allow(""),
       company_id: Joi.number(),
       url: Joi.string().allow("").required(),
       user: Joi.any().required(),
@@ -2282,7 +2292,7 @@ class CatalogModel {
       is_set: Joi.boolean(),
       item_code: Joi.string().allow("").required(),
       item_type: Joi.string().allow("").required(),
-      media: Joi.array().items(CatalogModel.Media1()),
+      media: Joi.array().items(CatalogModel.Media()),
       multi_size: Joi.boolean(),
       name: Joi.string().allow("").required(),
       net_quantity: CatalogModel.NetQuantity(),
@@ -2320,7 +2330,7 @@ class CatalogModel {
       image_nature: Joi.string().allow(""),
       item_code: Joi.string().allow(""),
       item_type: Joi.string().allow(""),
-      medias: Joi.array().items(CatalogModel.Media1()),
+      medias: Joi.array().items(CatalogModel.Media()),
       name: Joi.string().allow(""),
       product_online_date: Joi.string().allow(""),
       promo_meta: Joi.any(),
@@ -2399,7 +2409,7 @@ class CatalogModel {
       image_nature: Joi.string().allow(""),
       item_code: Joi.string().allow(""),
       item_type: Joi.string().allow(""),
-      medias: Joi.array().items(CatalogModel.Media1()),
+      medias: Joi.array().items(CatalogModel.Media()),
       name: Joi.string().allow(""),
       price: CatalogModel.ProductListingPrice(),
       product_online_date: Joi.string().allow(""),
@@ -2493,7 +2503,7 @@ class CatalogModel {
       item_code: Joi.string().allow(""),
       item_type: Joi.string().allow(""),
       l3_mapping: Joi.array().items(Joi.string().allow("")),
-      media: Joi.array().items(CatalogModel.Media1()),
+      media: Joi.array().items(CatalogModel.Media()),
       modified_by: Joi.any(),
       modified_on: Joi.string().allow(""),
       moq: Joi.any(),
@@ -2610,7 +2620,7 @@ class CatalogModel {
       brand_uid: Joi.number(),
       category_uid: Joi.number(),
       item_code: Joi.string().allow(""),
-      media: Joi.array().items(CatalogModel.Media1()),
+      media: Joi.array().items(CatalogModel.Media()),
       name: Joi.string().allow(""),
       uid: Joi.number(),
     });
@@ -2923,7 +2933,7 @@ class CatalogModel {
   static Trader() {
     return Joi.object({
       address: Joi.array().items(Joi.string().allow("")),
-      name: Joi.any().required(),
+      name: Joi.string().allow("").required(),
       type: Joi.string().allow(""),
     });
   }
@@ -3180,7 +3190,9 @@ class CatalogModel {
 
       "shipping-policy",
 
-      "return-policy"
+      "return-policy",
+
+      "order-status"
     );
   }
 }

package/sdk/platform/Common/CommonPlatformModel.js

@@ -96,14 +96,18 @@ class CommonModel {
       __v: Joi.number(),
       _id: Joi.string().allow(""),
       capital: Joi.string().allow(""),
+      country_code: Joi.string().allow(""),
       currency: Joi.string().allow(""),
       default_currency: CommonModel.LocationDefaultCurrency(),
       default_language: CommonModel.LocationDefaultLanguage(),
       iso2: Joi.string().allow(""),
       iso3: Joi.string().allow(""),
+      latitude: Joi.string().allow(""),
+      longitude: Joi.string().allow(""),
       name: Joi.string().allow(""),
       parent: Joi.string().allow(""),
       phone_code: Joi.string().allow(""),
+      state_code: Joi.string().allow(""),
       type: Joi.string().allow(""),
       uid: Joi.number(),
     });

package/sdk/platform/Communication/CommunicationPlatformModel.d.ts

@@ -66,6 +66,7 @@ declare class CommunicationModel {
     static SendOtpCommsRes(): any;
     static SendOtpCommsResEmail(): any;
     static SendOtpCommsResSms(): any;
+    static SendOtpEmailCommsProvider(): any;
     static SendOtpEmailCommsTemplate(): any;
     static SendOtpSmsCommsProvider(): any;
     static SendOtpSmsCommsTemplate(): any;

package/sdk/platform/Communication/CommunicationPlatformModel.js

@@ -375,6 +375,7 @@ class CommunicationModel {
     return Joi.object({
       _id: Joi.string().allow(""),
       application: Joi.string().allow(""),
+      channel_type: Joi.string().allow(""),
       created_at: Joi.string().allow(""),
       data: Joi.any(),
       email: CommunicationModel.LogEmail(),
@@ -382,6 +383,7 @@ class CommunicationModel {
       meta: CommunicationModel.LogMeta(),
       pushnotification: CommunicationModel.LogPushnotification(),
       service: Joi.string().allow(""),
+      source: Joi.string().allow(""),
       status: Joi.string().allow(""),
       step: Joi.string().allow(""),
     });
@@ -535,6 +537,7 @@ class CommunicationModel {
     return Joi.object({
       expiry: Joi.number(),
       otp_length: Joi.number(),
+      provider: CommunicationModel.SendOtpEmailCommsProvider(),
       template: CommunicationModel.SendOtpEmailCommsTemplate(),
     });
   }
@@ -571,6 +574,12 @@ class CommunicationModel {
       success: Joi.boolean(),
     });
   }
+  static SendOtpEmailCommsProvider() {
+    return Joi.object({
+      _id: Joi.string().allow(""),
+      slug: Joi.string().allow(""),
+    });
+  }
   static SendOtpEmailCommsTemplate() {
     return Joi.object({
       key: Joi.string().allow(""),

package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts

@@ -65,8 +65,8 @@ declare class CompanyProfile {
      * @param {Object} arg - Arg object.
      * @param {string} arg.brandId - Id of the brand to be viewed.
      * @returns {Promise<GetBrandResponseSerializer>} - Success response
-     * @summary: Get a single brand.
-     * @description: This API helps to get data associated to a particular brand.
+     * @summary: Get a single company brand.
+     * @description: This API helps to get data associated to a particular company brand.
      */
     getBrand({ brandId }?: {
         brandId: string;

package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js

@@ -407,8 +407,8 @@ class CompanyProfile {
    * @param {Object} arg - Arg object.
    * @param {string} arg.brandId - Id of the brand to be viewed.
    * @returns {Promise<GetBrandResponseSerializer>} - Success response
-   * @summary: Get a single brand.
-   * @description: This API helps to get data associated to a particular brand.
+   * @summary: Get a single company brand.
+   * @description: This API helps to get data associated to a particular company brand.
    */
   async getBrand({ brandId } = {}) {
     const { error } = CompanyProfileValidator.getBrand().validate(

package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js

@@ -18,8 +18,8 @@ class CompanyProfileModel {
   }
   static BrandBannerSerializer() {
     return Joi.object({
-      landscape: Joi.string().allow(""),
-      portrait: Joi.string().allow(""),
+      landscape: Joi.string().allow("").required(),
+      portrait: Joi.string().allow("").required(),
     });
   }
   static BulkLocationSerializer() {
@@ -140,7 +140,7 @@ class CompanyProfileModel {
     return Joi.object({
       _custom_json: Joi.any(),
       _locale_language: Joi.any(),
-      banner: CompanyProfileModel.BrandBannerSerializer(),
+      banner: CompanyProfileModel.BrandBannerSerializer().required(),
       brand_tier: Joi.string().allow(""),
       company_id: Joi.number(),
       description: Joi.string().allow(""),
@@ -218,7 +218,7 @@ class CompanyProfileModel {
       business_country_info: CompanyProfileModel.BusinessCountryInfo(),
       business_details: CompanyProfileModel.BusinessDetails(),
       business_info: Joi.string().allow(""),
-      business_type: Joi.string().allow("").required(),
+      business_type: Joi.string().allow(""),
       company_type: Joi.string().allow("").required(),
       contact_details: CompanyProfileModel.ContactDetails(),
       created_by: CompanyProfileModel.UserSerializer(),
@@ -401,6 +401,7 @@ class CompanyProfileModel {
   }
   static ProfileSuccessResponse() {
     return Joi.object({
+      message: Joi.string().allow(""),
       success: Joi.boolean(),
       uid: Joi.number(),
     });