@gofynd/fdk-client-javascript 1.4.8-beta.3 → 1.4.9

package/sdk/platform/Content/ContentPlatformModel.d.ts

@@ -159,7 +159,11 @@ export = ContentPlatformModel;
  * @typedef BlogGetResponse
  * @property {BlogSchema[]} [items]
  * @property {Page} [page]
- * @property {string[]} [filters]
+ * @property {BlogFilters} [filters]
+ */
+/**
+ * @typedef BlogFilters
+ * @property {string[]} [tags]
  */
 /**
  * @typedef ResourceContent
@@ -290,7 +294,7 @@ export = ContentPlatformModel;
  */
 /**
  * @typedef Action
- * @property {string} [type]
+ * @property {string} [type] - Type of action to be taken e.g, page.
  * @property {ActionPage} [page]
  * @property {ActionPage} [popup]
  */
@@ -490,13 +494,13 @@ export = ContentPlatformModel;
  */
 /**
  * @typedef Page
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {boolean} [has_previous]
- * @property {boolean} [has_next]
- * @property {number} [current]
- * @property {string} type
- * @property {number} [size]
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
  */
 /**
  * @typedef LandingPageGetResponse
@@ -665,7 +669,6 @@ export = ContentPlatformModel;
  * @typedef Support
  * @property {boolean} [created]
  * @property {string} [_id]
- * @property {string} [config_type]
  * @property {string} [application]
  * @property {string} [created_at]
  * @property {string} [updated_at]
@@ -1174,9 +1177,9 @@ export = ContentPlatformModel;
  */
 /**
  * @typedef ActionPage
- * @property {Object} [params]
- * @property {Object} [query]
- * @property {string} [url]
+ * @property {Object} [params] - Parameters that should be considered in path.
+ * @property {Object} [query] - Query parameter if any to be added to the action.
+ * @property {string} [url] - The URL for the action.
  * @property {PageType} type
  */
 /** @typedef {"title" | "description"} GenerationEntityType */
@@ -1192,6 +1195,7 @@ export = ContentPlatformModel;
  *   | "category"
  *   | "collection"
  *   | "collections"
+ *   | "custom"
  *   | "contact-us"
  *   | "external"
  *   | "faq"
@@ -1231,7 +1235,7 @@ export = ContentPlatformModel;
 declare class ContentPlatformModel {
 }
 declare namespace ContentPlatformModel {
-    export { GenerateSEOContent, GeneratedSEOContent, ApplicationLegal, ApplicationLegalFAQ, PathMappingSchema, PathSourceSchema, SeoComponent, SeoSchema, CustomMetaTag, Detail, SeoSchemaComponent, SEOSchemaMarkupTemplate, SEOSchemaMarkupTemplateRequestBody, AnnouncementPageSchema, EditorMeta, AnnouncementAuthorSchema, AdminAnnouncementSchema, DefaultSchemaComponent, DefaultSEOSchemaMarkupTemplate, ScheduleSchema, NextSchedule, BlogGetResponse, ResourceContent, Asset, Author, BlogSchema, SEO, SEOImage, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, DateMeta, BlogRequest, GetAnnouncementListSchema, CreateAnnouncementSchema, DataLoaderResponseSchema, DataLoaderResetResponseSchema, LocaleLanguage, Language, Action, NavigationReference, CronBasedScheduleSchema, ConfigurationSchema, SlideshowMedia, UpdateHandpickedSchema, HandpickedTagSchema, RemoveHandpickedSchema, CreateTagSchema, CreateTagRequestSchema, DataLoaderSchema, DataLoaderSourceSchema, DataLoadersSchema, TagDeleteSuccessResponse, ContentAPIError, CommonError, CategorySchema, ChildrenSchema, CategoryRequestSchema, FAQCategorySchema, FaqSchema, FAQ, CreateFaqResponseSchema, CreateFaqSchema, GetFaqSchema, UpdateFaqCategoryRequestSchema, CreateFaqCategoryRequestSchema, CreateFaqCategorySchema, GetFaqCategoriesSchema, GetFaqCategoryBySlugSchema, Page, LandingPageGetResponse, LandingPageSchema, DefaultNavigationResponse, NavigationGetResponse, Orientation, NavigationSchema, NavigationRequest, PageGetResponse, PageSpec, PageSpecParam, PageSpecItem, PageSchema, CreatedBySchema, PageRequest, CronSchedule, PagePublishRequest, PageMetaSchema, SlideshowGetResponse, SlideshowSchema, SlideshowRequest, Support, PhoneProperties, PhoneSchema, EmailProperties, EmailSchema, ContactSchema, TagsSchema, TagSchema, TagSourceSchema, ResourcesSchema, ResourceSchema, FieldValidations, FieldDefinitionSchema, CustomFieldDefinitionsSchema, CustomFieldDefinitionRequestSchema, CustomObjectCustomFieldDefinitions, CustomObjectDefinitionUpdateRequestSchema, CustomFieldDefinitionDetailResSchema, CustomDataDeleteSchema, CustomFieldValue, CustomFieldSchema, CustomFieldsResponseSchema, CustomFieldsResponseByResourceIdSchema, CustomField, CustomFieldRequestSchema, CustomObjectSchema, CustomObjectDefinitionRequestSchema, CustomObjectCustomFieldDefinitionResSchema, CustomObjectDefinitionSchema, CustomObjectDefinitionDeleteResponseSchema, CustomObjectEntryBulkUploadResponse, CustomObjectListItemDefinationSchema, CustomObjectListItemSchema, CustomObjectsSchema, CustomObjectFieldSchema, CustomObjectByIdSchema, CustomObjectBulkEntryInitiateDownload, CustomObjectMetaSchema, CustomObjectJobSchema, CustomObjectBulkEntry, CustomFieldTypeSchema, SupportedValidationsMetaExampleSchema, SupportedValidationsMetaSchema, SupportedValidationsSchema, StringSingleLine, StringMultiLine, Dropdown, Integer, FloatType, BooleanType, Date, Datetime, Json, File, Url, Metaobject, Product, CustomObjectEntry, CustomObjectDefinitionsSchema, CustomObjectEntryFieldSchema, CustomObjectRequestSchema, CustomObjectBulkSchema, ActionPage, GenerationEntityType, PageType };
+    export { GenerateSEOContent, GeneratedSEOContent, ApplicationLegal, ApplicationLegalFAQ, PathMappingSchema, PathSourceSchema, SeoComponent, SeoSchema, CustomMetaTag, Detail, SeoSchemaComponent, SEOSchemaMarkupTemplate, SEOSchemaMarkupTemplateRequestBody, AnnouncementPageSchema, EditorMeta, AnnouncementAuthorSchema, AdminAnnouncementSchema, DefaultSchemaComponent, DefaultSEOSchemaMarkupTemplate, ScheduleSchema, NextSchedule, BlogGetResponse, BlogFilters, ResourceContent, Asset, Author, BlogSchema, SEO, SEOImage, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, DateMeta, BlogRequest, GetAnnouncementListSchema, CreateAnnouncementSchema, DataLoaderResponseSchema, DataLoaderResetResponseSchema, LocaleLanguage, Language, Action, NavigationReference, CronBasedScheduleSchema, ConfigurationSchema, SlideshowMedia, UpdateHandpickedSchema, HandpickedTagSchema, RemoveHandpickedSchema, CreateTagSchema, CreateTagRequestSchema, DataLoaderSchema, DataLoaderSourceSchema, DataLoadersSchema, TagDeleteSuccessResponse, ContentAPIError, CommonError, CategorySchema, ChildrenSchema, CategoryRequestSchema, FAQCategorySchema, FaqSchema, FAQ, CreateFaqResponseSchema, CreateFaqSchema, GetFaqSchema, UpdateFaqCategoryRequestSchema, CreateFaqCategoryRequestSchema, CreateFaqCategorySchema, GetFaqCategoriesSchema, GetFaqCategoryBySlugSchema, Page, LandingPageGetResponse, LandingPageSchema, DefaultNavigationResponse, NavigationGetResponse, Orientation, NavigationSchema, NavigationRequest, PageGetResponse, PageSpec, PageSpecParam, PageSpecItem, PageSchema, CreatedBySchema, PageRequest, CronSchedule, PagePublishRequest, PageMetaSchema, SlideshowGetResponse, SlideshowSchema, SlideshowRequest, Support, PhoneProperties, PhoneSchema, EmailProperties, EmailSchema, ContactSchema, TagsSchema, TagSchema, TagSourceSchema, ResourcesSchema, ResourceSchema, FieldValidations, FieldDefinitionSchema, CustomFieldDefinitionsSchema, CustomFieldDefinitionRequestSchema, CustomObjectCustomFieldDefinitions, CustomObjectDefinitionUpdateRequestSchema, CustomFieldDefinitionDetailResSchema, CustomDataDeleteSchema, CustomFieldValue, CustomFieldSchema, CustomFieldsResponseSchema, CustomFieldsResponseByResourceIdSchema, CustomField, CustomFieldRequestSchema, CustomObjectSchema, CustomObjectDefinitionRequestSchema, CustomObjectCustomFieldDefinitionResSchema, CustomObjectDefinitionSchema, CustomObjectDefinitionDeleteResponseSchema, CustomObjectEntryBulkUploadResponse, CustomObjectListItemDefinationSchema, CustomObjectListItemSchema, CustomObjectsSchema, CustomObjectFieldSchema, CustomObjectByIdSchema, CustomObjectBulkEntryInitiateDownload, CustomObjectMetaSchema, CustomObjectJobSchema, CustomObjectBulkEntry, CustomFieldTypeSchema, SupportedValidationsMetaExampleSchema, SupportedValidationsMetaSchema, SupportedValidationsSchema, StringSingleLine, StringMultiLine, Dropdown, Integer, FloatType, BooleanType, Date, Datetime, Json, File, Url, Metaobject, Product, CustomObjectEntry, CustomObjectDefinitionsSchema, CustomObjectEntryFieldSchema, CustomObjectRequestSchema, CustomObjectBulkSchema, ActionPage, GenerationEntityType, PageType };
 }
 /** @returns {GenerateSEOContent} */
 declare function GenerateSEOContent(): GenerateSEOContent;
@@ -1415,7 +1419,12 @@ declare function BlogGetResponse(): BlogGetResponse;
 type BlogGetResponse = {
     items?: BlogSchema[];
     page?: Page;
-    filters?: string[];
+    filters?: BlogFilters;
+};
+/** @returns {BlogFilters} */
+declare function BlogFilters(): BlogFilters;
+type BlogFilters = {
+    tags?: string[];
 };
 /** @returns {ResourceContent} */
 declare function ResourceContent(): ResourceContent;
@@ -1565,6 +1574,9 @@ type Language = {
 /** @returns {Action} */
 declare function Action(): Action;
 type Action = {
+    /**
+     * - Type of action to be taken e.g, page.
+     */
     type?: string;
     page?: ActionPage;
     popup?: ActionPage;
@@ -1795,12 +1807,33 @@ type GetFaqCategoryBySlugSchema = {
 /** @returns {Page} */
 declare function Page(): Page;
 type Page = {
+    /**
+     * - The total number of items on the page.
+     */
     item_total?: number;
+    /**
+     * - The identifier for the next page.
+     */
     next_id?: string;
+    /**
+     * - Indicates whether there is a previous page.
+     */
     has_previous?: boolean;
+    /**
+     * - Indicates whether there is a next page.
+     */
     has_next?: boolean;
+    /**
+     * - The current page number.
+     */
     current?: number;
+    /**
+     * - The type of the page, such as 'PageType'.
+     */
     type: string;
+    /**
+     * - The number of items per page.
+     */
     size?: number;
 };
 /** @returns {LandingPageGetResponse} */
@@ -1994,7 +2027,6 @@ declare function Support(): Support;
 type Support = {
     created?: boolean;
     _id?: string;
-    config_type?: string;
     application?: string;
     created_at?: string;
     updated_at?: string;
@@ -2574,8 +2606,17 @@ type CustomObjectBulkSchema = {
 /** @returns {ActionPage} */
 declare function ActionPage(): ActionPage;
 type ActionPage = {
+    /**
+     * - Parameters that should be considered in path.
+     */
     params?: any;
+    /**
+     * - Query parameter if any to be added to the action.
+     */
     query?: any;
+    /**
+     * - The URL for the action.
+     */
     url?: string;
     type: PageType;
 };
@@ -2592,4 +2633,4 @@ type GenerationEntityType = "title" | "description";
  * @returns {PageType}
  */
 declare function PageType(): PageType;
-type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-emails" | "profile-phones" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status";
+type PageType = "about-us" | "addresses" | "blog" | "brands" | "cards" | "cart" | "categories" | "brand" | "category" | "collection" | "collections" | "custom" | "contact-us" | "external" | "faq" | "freshchat" | "home" | "notification-settings" | "orders" | "page" | "policy" | "product" | "product-request" | "products" | "profile" | "profile-order-shipment" | "profile-basic" | "profile-company" | "profile-emails" | "profile-phones" | "rate-us" | "refer-earn" | "settings" | "shared-cart" | "tnc" | "track-order" | "wishlist" | "sections" | "form" | "cart-delivery" | "cart-payment" | "cart-review" | "login" | "register" | "shipping-policy" | "return-policy" | "order-status";

package/sdk/platform/Content/ContentPlatformModel.js

@@ -181,7 +181,12 @@ const Joi = require("joi");
  * @typedef BlogGetResponse
  * @property {BlogSchema[]} [items]
  * @property {Page} [page]
- * @property {string[]} [filters]
+ * @property {BlogFilters} [filters]
+ */
+
+/**
+ * @typedef BlogFilters
+ * @property {string[]} [tags]
  */
 
 /**
@@ -331,7 +336,7 @@ const Joi = require("joi");
 
 /**
  * @typedef Action
- * @property {string} [type]
+ * @property {string} [type] - Type of action to be taken e.g, page.
  * @property {ActionPage} [page]
  * @property {ActionPage} [popup]
  */
@@ -561,13 +566,13 @@ const Joi = require("joi");
 
 /**
  * @typedef Page
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {boolean} [has_previous]
- * @property {boolean} [has_next]
- * @property {number} [current]
- * @property {string} type
- * @property {number} [size]
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
  */
 
 /**
@@ -757,7 +762,6 @@ const Joi = require("joi");
  * @typedef Support
  * @property {boolean} [created]
  * @property {string} [_id]
- * @property {string} [config_type]
  * @property {string} [application]
  * @property {string} [created_at]
  * @property {string} [updated_at]
@@ -1328,9 +1332,9 @@ const Joi = require("joi");
 
 /**
  * @typedef ActionPage
- * @property {Object} [params]
- * @property {Object} [query]
- * @property {string} [url]
+ * @property {Object} [params] - Parameters that should be considered in path.
+ * @property {Object} [query] - Query parameter if any to be added to the action.
+ * @property {string} [url] - The URL for the action.
  * @property {PageType} type
  */
 
@@ -1348,6 +1352,7 @@ const Joi = require("joi");
  *   | "category"
  *   | "collection"
  *   | "collections"
+ *   | "custom"
  *   | "contact-us"
  *   | "external"
  *   | "faq"
@@ -1612,7 +1617,14 @@ class ContentPlatformModel {
     return Joi.object({
       items: Joi.array().items(ContentPlatformModel.BlogSchema()),
       page: ContentPlatformModel.Page(),
-      filters: Joi.array().items(Joi.string().allow("")),
+      filters: ContentPlatformModel.BlogFilters(),
+    });
+  }
+
+  /** @returns {BlogFilters} */
+  static BlogFilters() {
+    return Joi.object({
+      tags: Joi.array().items(Joi.string().allow("")),
     });
   }
 
@@ -2327,7 +2339,6 @@ class ContentPlatformModel {
     return Joi.object({
       created: Joi.boolean(),
       _id: Joi.string().allow(""),
-      config_type: Joi.string().allow(""),
       application: Joi.string().allow(""),
       created_at: Joi.string().allow(""),
       updated_at: Joi.string().allow(""),
@@ -3115,6 +3126,8 @@ class ContentPlatformModel {
 
       "collections",
 
+      "custom",
+
       "contact-us",
 
       "external",

package/sdk/platform/Discount/DiscountPlatformModel.d.ts

@@ -140,13 +140,13 @@ export = DiscountPlatformModel;
  */
 /**
  * @typedef Page
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {boolean} [has_previous]
- * @property {boolean} [has_next]
- * @property {number} [current]
- * @property {string} type
- * @property {number} [size]
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
  */
 /**
  * @typedef UserDetails
@@ -338,12 +338,33 @@ type CancelJobResponse = {
 /** @returns {Page} */
 declare function Page(): Page;
 type Page = {
+    /**
+     * - The total number of items on the page.
+     */
     item_total?: number;
+    /**
+     * - The identifier for the next page.
+     */
     next_id?: string;
+    /**
+     * - Indicates whether there is a previous page.
+     */
     has_previous?: boolean;
+    /**
+     * - Indicates whether there is a next page.
+     */
     has_next?: boolean;
+    /**
+     * - The current page number.
+     */
     current?: number;
+    /**
+     * - The type of the page, such as 'PageType'.
+     */
     type: string;
+    /**
+     * - The number of items per page.
+     */
     size?: number;
 };
 /** @returns {UserDetails} */

package/sdk/platform/Discount/DiscountPlatformModel.js

@@ -153,13 +153,13 @@ const Joi = require("joi");
 
 /**
  * @typedef Page
- * @property {number} [item_total]
- * @property {string} [next_id]
- * @property {boolean} [has_previous]
- * @property {boolean} [has_next]
- * @property {number} [current]
- * @property {string} type
- * @property {number} [size]
+ * @property {number} [item_total] - The total number of items on the page.
+ * @property {string} [next_id] - The identifier for the next page.
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
+ * @property {number} [current] - The current page number.
+ * @property {string} type - The type of the page, such as 'PageType'.
+ * @property {number} [size] - The number of items per page.
  */
 
 /**

package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts

@@ -152,27 +152,33 @@ export = FileStoragePlatformModel;
  */
 /**
  * @typedef CompanyDetail
- * @property {string} [name]
- * @property {string} [address]
- * @property {string} [city]
- * @property {string} [state]
- * @property {string} [country]
- * @property {number} [zip_code]
- * @property {string} [state_code]
- * @property {string} [country_code]
- * @property {string} [gstin]
- * @property {string} [pan]
- * @property {string} [phone_no]
- * @property {string} [cin]
- * @property {string} [website_url]
- * @property {string} [email]
- * @property {string} [display_address]
- * @property {string} [sector]
- * @property {Object} [phone]
- * @property {string} [trn]
- * @property {string} [vat]
- * @property {string} [business_country_timezone]
- * @property {Object} [business_country_currency]
+ * @property {string} [name] - The official name of the company.
+ * @property {string} [address] - The physical street address of the company.
+ * @property {string} [city] - The city where the company is located.
+ * @property {string} [state] - The state or province where the company is located.
+ * @property {string} [country] - The country where the company is based.
+ * @property {number} [zip_code] - The postal code for the company's location.
+ * @property {string} [state_code] - A code representing the state, often used
+ *   in official documents and forms.
+ * @property {string} [country_code] - The code of the country.
+ * @property {string} [gstin] - The Goods and Services Tax Identification
+ *   Number, unique to each business in India.
+ * @property {string} [pan] - The Permanent Account Number, unique to each
+ *   taxpayer in India.
+ * @property {string} [phone_no] - The primary contact phone number for the company.
+ * @property {string} [cin] - The Corporate Identification Number, unique to
+ *   each company registered in India.
+ * @property {string} [website_url] - The URL to the company's official website.
+ * @property {string} [email] - The company's official email address.
+ * @property {string} [display_address] - The display address of the company.
+ * @property {string} [sector] - The sector in which company is located.
+ * @property {Object} [phone] - The provided phone no of country.
+ * @property {string} [trn] - The trn no of the company.
+ * @property {string} [vat] - The vat no of the company.
+ * @property {string} [business_country_timezone] - The bussiness country timezone.
+ * @property {Object} [business_country_currency] - This object represents the
+ *   bussiness country currency.
+ * @property {Object} [meta] - This object represents the meta fields for company.
  */
 /**
  * @typedef StoreDetail
@@ -412,6 +418,8 @@ export = FileStoragePlatformModel;
  * @property {boolean} [is_self_ship]
  * @property {string} [mode]
  * @property {boolean} [is_self_pickup]
+ * @property {Object} [shipment_meta] - This field represents the shipment meta details
+ * @property {Object} [order_meta] - This field represents the order meta details
  * @property {string} [platform_name]
  * @property {number} [amount_to_be_collected]
  * @property {number} [amount_paid]
@@ -427,11 +435,12 @@ export = FileStoragePlatformModel;
  */
 /**
  * @typedef DummyTemplateData
- * @property {string} [_id]
- * @property {number} [pdf_type_id]
+ * @property {string} [_id] - This field contains the unique identifier for the
+ *   PDF payload.
+ * @property {number} [pdf_type_id] - This is invoice unique id
  * @property {DummyTemplateDataPayload} payload
- * @property {string} [country_code]
- * @property {number} [__v]
+ * @property {string} [country_code] - This field represents the country code.
+ * @property {number} [__v] - This field holds the version number.
  */
 /**
  * @typedef DummyTemplateDataItems
@@ -741,27 +750,99 @@ type InvoiceDetail = {
 /** @returns {CompanyDetail} */
 declare function CompanyDetail(): CompanyDetail;
 type CompanyDetail = {
+    /**
+     * - The official name of the company.
+     */
     name?: string;
+    /**
+     * - The physical street address of the company.
+     */
     address?: string;
+    /**
+     * - The city where the company is located.
+     */
     city?: string;
+    /**
+     * - The state or province where the company is located.
+     */
     state?: string;
+    /**
+     * - The country where the company is based.
+     */
     country?: string;
+    /**
+     * - The postal code for the company's location.
+     */
     zip_code?: number;
+    /**
+     * - A code representing the state, often used
+     * in official documents and forms.
+     */
     state_code?: string;
+    /**
+     * - The code of the country.
+     */
     country_code?: string;
+    /**
+     * - The Goods and Services Tax Identification
+     * Number, unique to each business in India.
+     */
     gstin?: string;
+    /**
+     * - The Permanent Account Number, unique to each
+     * taxpayer in India.
+     */
     pan?: string;
+    /**
+     * - The primary contact phone number for the company.
+     */
     phone_no?: string;
+    /**
+     * - The Corporate Identification Number, unique to
+     * each company registered in India.
+     */
     cin?: string;
+    /**
+     * - The URL to the company's official website.
+     */
     website_url?: string;
+    /**
+     * - The company's official email address.
+     */
     email?: string;
+    /**
+     * - The display address of the company.
+     */
     display_address?: string;
+    /**
+     * - The sector in which company is located.
+     */
     sector?: string;
+    /**
+     * - The provided phone no of country.
+     */
     phone?: any;
+    /**
+     * - The trn no of the company.
+     */
     trn?: string;
+    /**
+     * - The vat no of the company.
+     */
     vat?: string;
+    /**
+     * - The bussiness country timezone.
+     */
     business_country_timezone?: string;
+    /**
+     * - This object represents the
+     * bussiness country currency.
+     */
     business_country_currency?: any;
+    /**
+     * - This object represents the meta fields for company.
+     */
+    meta?: any;
 };
 /** @returns {StoreDetail} */
 declare function StoreDetail(): StoreDetail;
@@ -1027,6 +1108,14 @@ type DummyTemplateDataPayload = {
     is_self_ship?: boolean;
     mode?: string;
     is_self_pickup?: boolean;
+    /**
+     * - This field represents the shipment meta details
+     */
+    shipment_meta?: any;
+    /**
+     * - This field represents the order meta details
+     */
+    order_meta?: any;
     platform_name?: string;
     amount_to_be_collected?: number;
     amount_paid?: number;
@@ -1043,10 +1132,23 @@ type DummyTemplateDataPayload = {
 /** @returns {DummyTemplateData} */
 declare function DummyTemplateData(): DummyTemplateData;
 type DummyTemplateData = {
+    /**
+     * - This field contains the unique identifier for the
+     * PDF payload.
+     */
     _id?: string;
+    /**
+     * - This is invoice unique id
+     */
     pdf_type_id?: number;
     payload: DummyTemplateDataPayload;
+    /**
+     * - This field represents the country code.
+     */
     country_code?: string;
+    /**
+     * - This field holds the version number.
+     */
     __v?: number;
 };
 /** @returns {DummyTemplateDataItems} */

package/sdk/platform/FileStorage/FileStoragePlatformModel.js

@@ -174,27 +174,33 @@ const Joi = require("joi");
 
 /**
  * @typedef CompanyDetail
- * @property {string} [name]
- * @property {string} [address]
- * @property {string} [city]
- * @property {string} [state]
- * @property {string} [country]
- * @property {number} [zip_code]
- * @property {string} [state_code]
- * @property {string} [country_code]
- * @property {string} [gstin]
- * @property {string} [pan]
- * @property {string} [phone_no]
- * @property {string} [cin]
- * @property {string} [website_url]
- * @property {string} [email]
- * @property {string} [display_address]
- * @property {string} [sector]
- * @property {Object} [phone]
- * @property {string} [trn]
- * @property {string} [vat]
- * @property {string} [business_country_timezone]
- * @property {Object} [business_country_currency]
+ * @property {string} [name] - The official name of the company.
+ * @property {string} [address] - The physical street address of the company.
+ * @property {string} [city] - The city where the company is located.
+ * @property {string} [state] - The state or province where the company is located.
+ * @property {string} [country] - The country where the company is based.
+ * @property {number} [zip_code] - The postal code for the company's location.
+ * @property {string} [state_code] - A code representing the state, often used
+ *   in official documents and forms.
+ * @property {string} [country_code] - The code of the country.
+ * @property {string} [gstin] - The Goods and Services Tax Identification
+ *   Number, unique to each business in India.
+ * @property {string} [pan] - The Permanent Account Number, unique to each
+ *   taxpayer in India.
+ * @property {string} [phone_no] - The primary contact phone number for the company.
+ * @property {string} [cin] - The Corporate Identification Number, unique to
+ *   each company registered in India.
+ * @property {string} [website_url] - The URL to the company's official website.
+ * @property {string} [email] - The company's official email address.
+ * @property {string} [display_address] - The display address of the company.
+ * @property {string} [sector] - The sector in which company is located.
+ * @property {Object} [phone] - The provided phone no of country.
+ * @property {string} [trn] - The trn no of the company.
+ * @property {string} [vat] - The vat no of the company.
+ * @property {string} [business_country_timezone] - The bussiness country timezone.
+ * @property {Object} [business_country_currency] - This object represents the
+ *   bussiness country currency.
+ * @property {Object} [meta] - This object represents the meta fields for company.
  */
 
 /**
@@ -460,6 +466,8 @@ const Joi = require("joi");
  * @property {boolean} [is_self_ship]
  * @property {string} [mode]
  * @property {boolean} [is_self_pickup]
+ * @property {Object} [shipment_meta] - This field represents the shipment meta details
+ * @property {Object} [order_meta] - This field represents the order meta details
  * @property {string} [platform_name]
  * @property {number} [amount_to_be_collected]
  * @property {number} [amount_paid]
@@ -476,11 +484,12 @@ const Joi = require("joi");
 
 /**
  * @typedef DummyTemplateData
- * @property {string} [_id]
- * @property {number} [pdf_type_id]
+ * @property {string} [_id] - This field contains the unique identifier for the
+ *   PDF payload.
+ * @property {number} [pdf_type_id] - This is invoice unique id
  * @property {DummyTemplateDataPayload} payload
- * @property {string} [country_code]
- * @property {number} [__v]
+ * @property {string} [country_code] - This field represents the country code.
+ * @property {number} [__v] - This field holds the version number.
  */
 
 /**
@@ -867,6 +876,7 @@ class FileStoragePlatformModel {
       vat: Joi.string().allow(""),
       business_country_timezone: Joi.string().allow(""),
       business_country_currency: Joi.object().pattern(/\S/, Joi.any()),
+      meta: Joi.object().pattern(/\S/, Joi.any()),
     });
   }
 
@@ -1184,6 +1194,8 @@ class FileStoragePlatformModel {
       is_self_ship: Joi.boolean(),
       mode: Joi.string().allow(""),
       is_self_pickup: Joi.boolean(),
+      shipment_meta: Joi.object().pattern(/\S/, Joi.any()),
+      order_meta: Joi.object().pattern(/\S/, Joi.any()),
       platform_name: Joi.string().allow(""),
       amount_to_be_collected: Joi.number(),
       amount_paid: Joi.number(),