@gofynd/fdk-client-javascript 1.4.8-beta.2 → 1.4.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -1
- package/package.json +2 -2
- package/sdk/application/ApplicationClient.d.ts +8 -0
- package/sdk/application/ApplicationClient.js +14 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +20 -20
- package/sdk/application/Cart/CartApplicationClient.js +20 -20
- package/sdk/application/Cart/CartApplicationModel.d.ts +2446 -664
- package/sdk/application/Cart/CartApplicationModel.js +783 -552
- package/sdk/application/Cart/CartApplicationValidator.d.ts +268 -194
- package/sdk/application/Cart/CartApplicationValidator.js +100 -114
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +53 -53
- package/sdk/application/Catalog/CatalogApplicationClient.js +53 -53
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2012 -503
- package/sdk/application/Catalog/CatalogApplicationModel.js +603 -453
- package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +64 -64
- package/sdk/application/Catalog/CatalogApplicationValidator.js +32 -32
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Common/CommonApplicationModel.d.ts +170 -90
- package/sdk/application/Common/CommonApplicationModel.js +59 -58
- package/sdk/application/Common/CommonApplicationValidator.d.ts +8 -5
- package/sdk/application/Common/CommonApplicationValidator.js +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +170 -35
- package/sdk/application/Communication/CommunicationApplicationModel.js +54 -33
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +15 -15
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +15 -15
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +624 -443
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +259 -248
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +32 -24
- package/sdk/application/Configuration/ConfigurationApplicationValidator.js +14 -13
- package/sdk/application/Content/ContentApplicationClient.d.ts +16 -16
- package/sdk/application/Content/ContentApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationModel.d.ts +1206 -281
- package/sdk/application/Content/ContentApplicationModel.js +342 -276
- package/sdk/application/Content/ContentApplicationValidator.d.ts +28 -17
- package/sdk/application/Content/ContentApplicationValidator.js +11 -10
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +146 -37
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +38 -36
- package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
- package/sdk/application/Lead/LeadApplicationClient.js +3 -3
- package/sdk/application/Lead/LeadApplicationModel.d.ts +195 -134
- package/sdk/application/Lead/LeadApplicationModel.js +110 -67
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +8 -8
- package/sdk/application/Lead/LeadApplicationValidator.js +4 -4
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +10 -10
- package/sdk/application/Logistic/LogisticApplicationClient.js +10 -10
- package/sdk/application/Logistic/LogisticApplicationModel.d.ts +1039 -221
- package/sdk/application/Logistic/LogisticApplicationModel.js +342 -199
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +76 -82
- package/sdk/application/Logistic/LogisticApplicationValidator.js +38 -41
- package/sdk/application/Order/OrderApplicationClient.d.ts +10 -10
- package/sdk/application/Order/OrderApplicationClient.js +10 -10
- package/sdk/application/Order/OrderApplicationModel.d.ts +1401 -324
- package/sdk/application/Order/OrderApplicationModel.js +392 -316
- package/sdk/application/Order/OrderApplicationValidator.d.ts +32 -30
- package/sdk/application/Order/OrderApplicationValidator.js +15 -14
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +43 -43
- package/sdk/application/Payment/PaymentApplicationClient.js +43 -43
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +1111 -1022
- package/sdk/application/Payment/PaymentApplicationModel.js +537 -521
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +82 -49
- package/sdk/application/Payment/PaymentApplicationValidator.js +30 -30
- package/sdk/application/Rewards/RewardsApplicationModel.d.ts +28 -7
- package/sdk/application/Rewards/RewardsApplicationModel.js +7 -7
- package/sdk/application/Share/ShareApplicationModel.d.ts +178 -38
- package/sdk/application/Share/ShareApplicationModel.js +53 -37
- package/sdk/application/Share/ShareApplicationValidator.d.ts +4 -2
- package/sdk/application/Share/ShareApplicationValidator.js +2 -1
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +14 -8
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +528 -287
- package/sdk/application/Theme/ThemeApplicationModel.js +208 -172
- package/sdk/application/Theme/ThemeApplicationValidator.d.ts +17 -12
- package/sdk/application/Theme/ThemeApplicationValidator.js +8 -6
- package/sdk/application/User/UserApplicationClient.d.ts +36 -36
- package/sdk/application/User/UserApplicationClient.js +36 -36
- package/sdk/application/User/UserApplicationModel.d.ts +1062 -255
- package/sdk/application/User/UserApplicationModel.js +298 -244
- package/sdk/application/User/UserApplicationValidator.d.ts +80 -80
- package/sdk/application/User/UserApplicationValidator.js +40 -40
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
- package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
- package/sdk/application/Webhook/WebhookApplicationModel.d.ts +20 -5
- package/sdk/application/Webhook/WebhookApplicationModel.js +5 -5
- package/sdk/common/Clickstream.js +95 -15
- package/sdk/common/Constant.d.ts +9 -0
- package/sdk/common/Constant.js +11 -0
- package/sdk/common/Utility.js +19 -0
- package/sdk/common/utils.js +8 -1
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +28 -7
- package/sdk/partner/Lead/LeadPartnerModel.js +7 -7
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +75 -8
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +59 -7
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +2 -2
- package/sdk/partner/PartnerClient.d.ts +8 -0
- package/sdk/partner/PartnerClient.js +14 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +20 -0
- package/sdk/partner/Theme/ThemePartnerClient.js +158 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +45 -6
- package/sdk/partner/Theme/ThemePartnerModel.js +33 -4
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +2 -0
- package/sdk/partner/Theme/ThemePartnerValidator.js +14 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +28 -7
- package/sdk/partner/Webhook/WebhookPartnerModel.js +7 -7
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +28 -7
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +7 -7
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +21 -10
- package/sdk/platform/Billing/BillingPlatformClient.js +167 -83
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +2849 -565
- package/sdk/platform/Billing/BillingPlatformModel.js +935 -556
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +30 -14
- package/sdk/platform/Billing/BillingPlatformValidator.js +31 -16
- package/sdk/platform/Cart/CartPlatformModel.d.ts +28 -7
- package/sdk/platform/Cart/CartPlatformModel.js +8 -8
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +20 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +37 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +16 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +12 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.js +41 -1
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +46 -12
- package/sdk/platform/Catalog/CatalogPlatformModel.js +14 -11
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +40 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +17 -0
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +28 -7
- package/sdk/platform/Communication/CommunicationPlatformModel.js +7 -7
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +28 -7
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +7 -7
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +0 -97
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +77 -782
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +24 -701
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +7 -539
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +1 -183
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +0 -134
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +0 -10
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +0 -79
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -15
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +0 -13
- package/sdk/platform/Content/ContentPlatformModel.d.ts +60 -17
- package/sdk/platform/Content/ContentPlatformModel.js +30 -15
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +28 -7
- package/sdk/platform/Discount/DiscountPlatformModel.js +7 -7
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +127 -25
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +37 -25
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +30 -30
- package/sdk/platform/Finance/FinancePlatformClient.js +30 -30
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +1601 -348
- package/sdk/platform/Finance/FinancePlatformModel.js +488 -352
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +28 -7
- package/sdk/platform/Lead/LeadPlatformModel.js +7 -7
- package/sdk/platform/Order/OrderPlatformClient.d.ts +22 -0
- package/sdk/platform/Order/OrderPlatformClient.js +165 -0
- package/sdk/platform/Order/OrderPlatformModel.d.ts +631 -39
- package/sdk/platform/Order/OrderPlatformModel.js +367 -41
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -1
- package/sdk/platform/Order/OrderPlatformValidator.js +28 -0
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +30 -9
- package/sdk/platform/Payment/PaymentPlatformModel.js +9 -9
- package/sdk/platform/PlatformClient.d.ts +8 -0
- package/sdk/platform/PlatformClient.js +14 -0
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +28 -7
- package/sdk/platform/Rewards/RewardsPlatformModel.js +7 -7
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +12 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +12 -9
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +4 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +139 -22
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +98 -21
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +4 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +4 -4
- package/sdk/platform/Share/SharePlatformModel.d.ts +28 -7
- package/sdk/platform/Share/SharePlatformModel.js +7 -7
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +18 -5
- package/sdk/platform/Theme/ThemePlatformModel.js +7 -4
- package/sdk/platform/User/UserPlatformModel.d.ts +18 -20
- package/sdk/platform/User/UserPlatformModel.js +9 -11
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +54 -33
- package/sdk/platform/Webhook/WebhookPlatformModel.js +33 -33
- package/sdk/public/Billing/BillingPublicClient.d.ts +11 -0
- package/sdk/public/Billing/BillingPublicClient.js +80 -0
- package/sdk/public/Billing/BillingPublicModel.d.ts +584 -99
- package/sdk/public/Billing/BillingPublicModel.js +252 -87
- package/sdk/public/Billing/BillingPublicValidator.d.ts +10 -1
- package/sdk/public/Billing/BillingPublicValidator.js +12 -0
- package/sdk/public/PublicClient.d.ts +0 -2
- package/sdk/public/PublicClient.js +0 -4
- package/sdk/public/index.d.ts +0 -1
- package/sdk/public/index.js +0 -2
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +0 -87
- package/sdk/public/Inventory/InventoryPublicClient.js +0 -529
- package/sdk/public/Inventory/InventoryPublicModel.d.ts +0 -393
- package/sdk/public/Inventory/InventoryPublicModel.js +0 -448
- package/sdk/public/Inventory/InventoryPublicValidator.d.ts +0 -91
- package/sdk/public/Inventory/InventoryPublicValidator.js +0 -85
|
@@ -159,7 +159,11 @@ export = ContentPlatformModel;
|
|
|
159
159
|
* @typedef BlogGetResponse
|
|
160
160
|
* @property {BlogSchema[]} [items]
|
|
161
161
|
* @property {Page} [page]
|
|
162
|
-
* @property {
|
|
162
|
+
* @property {BlogFilters} [filters]
|
|
163
|
+
*/
|
|
164
|
+
/**
|
|
165
|
+
* @typedef BlogFilters
|
|
166
|
+
* @property {string[]} [tags]
|
|
163
167
|
*/
|
|
164
168
|
/**
|
|
165
169
|
* @typedef ResourceContent
|
|
@@ -290,7 +294,7 @@ export = ContentPlatformModel;
|
|
|
290
294
|
*/
|
|
291
295
|
/**
|
|
292
296
|
* @typedef Action
|
|
293
|
-
* @property {string} [type]
|
|
297
|
+
* @property {string} [type] - Type of action to be taken e.g, page.
|
|
294
298
|
* @property {ActionPage} [page]
|
|
295
299
|
* @property {ActionPage} [popup]
|
|
296
300
|
*/
|
|
@@ -490,13 +494,13 @@ export = ContentPlatformModel;
|
|
|
490
494
|
*/
|
|
491
495
|
/**
|
|
492
496
|
* @typedef Page
|
|
493
|
-
* @property {number} [item_total]
|
|
494
|
-
* @property {string} [next_id]
|
|
495
|
-
* @property {boolean} [has_previous]
|
|
496
|
-
* @property {boolean} [has_next]
|
|
497
|
-
* @property {number} [current]
|
|
498
|
-
* @property {string} type
|
|
499
|
-
* @property {number} [size]
|
|
497
|
+
* @property {number} [item_total] - The total number of items on the page.
|
|
498
|
+
* @property {string} [next_id] - The identifier for the next page.
|
|
499
|
+
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
500
|
+
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
501
|
+
* @property {number} [current] - The current page number.
|
|
502
|
+
* @property {string} type - The type of the page, such as 'PageType'.
|
|
503
|
+
* @property {number} [size] - The number of items per page.
|
|
500
504
|
*/
|
|
501
505
|
/**
|
|
502
506
|
* @typedef LandingPageGetResponse
|
|
@@ -665,7 +669,6 @@ export = ContentPlatformModel;
|
|
|
665
669
|
* @typedef Support
|
|
666
670
|
* @property {boolean} [created]
|
|
667
671
|
* @property {string} [_id]
|
|
668
|
-
* @property {string} [config_type]
|
|
669
672
|
* @property {string} [application]
|
|
670
673
|
* @property {string} [created_at]
|
|
671
674
|
* @property {string} [updated_at]
|
|
@@ -676,6 +679,7 @@ export = ContentPlatformModel;
|
|
|
676
679
|
* @property {string} [key]
|
|
677
680
|
* @property {string} [code]
|
|
678
681
|
* @property {string} [number]
|
|
682
|
+
* @property {string} [phone_type]
|
|
679
683
|
*/
|
|
680
684
|
/**
|
|
681
685
|
* @typedef PhoneSchema
|
|
@@ -1173,9 +1177,9 @@ export = ContentPlatformModel;
|
|
|
1173
1177
|
*/
|
|
1174
1178
|
/**
|
|
1175
1179
|
* @typedef ActionPage
|
|
1176
|
-
* @property {Object} [params]
|
|
1177
|
-
* @property {Object} [query]
|
|
1178
|
-
* @property {string} [url]
|
|
1180
|
+
* @property {Object} [params] - Parameters that should be considered in path.
|
|
1181
|
+
* @property {Object} [query] - Query parameter if any to be added to the action.
|
|
1182
|
+
* @property {string} [url] - The URL for the action.
|
|
1179
1183
|
* @property {PageType} type
|
|
1180
1184
|
*/
|
|
1181
1185
|
/** @typedef {"title" | "description"} GenerationEntityType */
|
|
@@ -1191,6 +1195,7 @@ export = ContentPlatformModel;
|
|
|
1191
1195
|
* | "category"
|
|
1192
1196
|
* | "collection"
|
|
1193
1197
|
* | "collections"
|
|
1198
|
+
* | "custom"
|
|
1194
1199
|
* | "contact-us"
|
|
1195
1200
|
* | "external"
|
|
1196
1201
|
* | "faq"
|
|
@@ -1230,7 +1235,7 @@ export = ContentPlatformModel;
|
|
|
1230
1235
|
declare class ContentPlatformModel {
|
|
1231
1236
|
}
|
|
1232
1237
|
declare namespace ContentPlatformModel {
|
|
1233
|
-
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 };
|
|
1238
|
+
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 };
|
|
1234
1239
|
}
|
|
1235
1240
|
/** @returns {GenerateSEOContent} */
|
|
1236
1241
|
declare function GenerateSEOContent(): GenerateSEOContent;
|
|
@@ -1414,7 +1419,12 @@ declare function BlogGetResponse(): BlogGetResponse;
|
|
|
1414
1419
|
type BlogGetResponse = {
|
|
1415
1420
|
items?: BlogSchema[];
|
|
1416
1421
|
page?: Page;
|
|
1417
|
-
filters?:
|
|
1422
|
+
filters?: BlogFilters;
|
|
1423
|
+
};
|
|
1424
|
+
/** @returns {BlogFilters} */
|
|
1425
|
+
declare function BlogFilters(): BlogFilters;
|
|
1426
|
+
type BlogFilters = {
|
|
1427
|
+
tags?: string[];
|
|
1418
1428
|
};
|
|
1419
1429
|
/** @returns {ResourceContent} */
|
|
1420
1430
|
declare function ResourceContent(): ResourceContent;
|
|
@@ -1564,6 +1574,9 @@ type Language = {
|
|
|
1564
1574
|
/** @returns {Action} */
|
|
1565
1575
|
declare function Action(): Action;
|
|
1566
1576
|
type Action = {
|
|
1577
|
+
/**
|
|
1578
|
+
* - Type of action to be taken e.g, page.
|
|
1579
|
+
*/
|
|
1567
1580
|
type?: string;
|
|
1568
1581
|
page?: ActionPage;
|
|
1569
1582
|
popup?: ActionPage;
|
|
@@ -1794,12 +1807,33 @@ type GetFaqCategoryBySlugSchema = {
|
|
|
1794
1807
|
/** @returns {Page} */
|
|
1795
1808
|
declare function Page(): Page;
|
|
1796
1809
|
type Page = {
|
|
1810
|
+
/**
|
|
1811
|
+
* - The total number of items on the page.
|
|
1812
|
+
*/
|
|
1797
1813
|
item_total?: number;
|
|
1814
|
+
/**
|
|
1815
|
+
* - The identifier for the next page.
|
|
1816
|
+
*/
|
|
1798
1817
|
next_id?: string;
|
|
1818
|
+
/**
|
|
1819
|
+
* - Indicates whether there is a previous page.
|
|
1820
|
+
*/
|
|
1799
1821
|
has_previous?: boolean;
|
|
1822
|
+
/**
|
|
1823
|
+
* - Indicates whether there is a next page.
|
|
1824
|
+
*/
|
|
1800
1825
|
has_next?: boolean;
|
|
1826
|
+
/**
|
|
1827
|
+
* - The current page number.
|
|
1828
|
+
*/
|
|
1801
1829
|
current?: number;
|
|
1830
|
+
/**
|
|
1831
|
+
* - The type of the page, such as 'PageType'.
|
|
1832
|
+
*/
|
|
1802
1833
|
type: string;
|
|
1834
|
+
/**
|
|
1835
|
+
* - The number of items per page.
|
|
1836
|
+
*/
|
|
1803
1837
|
size?: number;
|
|
1804
1838
|
};
|
|
1805
1839
|
/** @returns {LandingPageGetResponse} */
|
|
@@ -1993,7 +2027,6 @@ declare function Support(): Support;
|
|
|
1993
2027
|
type Support = {
|
|
1994
2028
|
created?: boolean;
|
|
1995
2029
|
_id?: string;
|
|
1996
|
-
config_type?: string;
|
|
1997
2030
|
application?: string;
|
|
1998
2031
|
created_at?: string;
|
|
1999
2032
|
updated_at?: string;
|
|
@@ -2005,6 +2038,7 @@ type PhoneProperties = {
|
|
|
2005
2038
|
key?: string;
|
|
2006
2039
|
code?: string;
|
|
2007
2040
|
number?: string;
|
|
2041
|
+
phone_type?: string;
|
|
2008
2042
|
};
|
|
2009
2043
|
/** @returns {PhoneSchema} */
|
|
2010
2044
|
declare function PhoneSchema(): PhoneSchema;
|
|
@@ -2572,8 +2606,17 @@ type CustomObjectBulkSchema = {
|
|
|
2572
2606
|
/** @returns {ActionPage} */
|
|
2573
2607
|
declare function ActionPage(): ActionPage;
|
|
2574
2608
|
type ActionPage = {
|
|
2609
|
+
/**
|
|
2610
|
+
* - Parameters that should be considered in path.
|
|
2611
|
+
*/
|
|
2575
2612
|
params?: any;
|
|
2613
|
+
/**
|
|
2614
|
+
* - Query parameter if any to be added to the action.
|
|
2615
|
+
*/
|
|
2576
2616
|
query?: any;
|
|
2617
|
+
/**
|
|
2618
|
+
* - The URL for the action.
|
|
2619
|
+
*/
|
|
2577
2620
|
url?: string;
|
|
2578
2621
|
type: PageType;
|
|
2579
2622
|
};
|
|
@@ -2590,4 +2633,4 @@ type GenerationEntityType = "title" | "description";
|
|
|
2590
2633
|
* @returns {PageType}
|
|
2591
2634
|
*/
|
|
2592
2635
|
declare function PageType(): PageType;
|
|
2593
|
-
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";
|
|
2636
|
+
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";
|
|
@@ -181,7 +181,12 @@ const Joi = require("joi");
|
|
|
181
181
|
* @typedef BlogGetResponse
|
|
182
182
|
* @property {BlogSchema[]} [items]
|
|
183
183
|
* @property {Page} [page]
|
|
184
|
-
* @property {
|
|
184
|
+
* @property {BlogFilters} [filters]
|
|
185
|
+
*/
|
|
186
|
+
|
|
187
|
+
/**
|
|
188
|
+
* @typedef BlogFilters
|
|
189
|
+
* @property {string[]} [tags]
|
|
185
190
|
*/
|
|
186
191
|
|
|
187
192
|
/**
|
|
@@ -331,7 +336,7 @@ const Joi = require("joi");
|
|
|
331
336
|
|
|
332
337
|
/**
|
|
333
338
|
* @typedef Action
|
|
334
|
-
* @property {string} [type]
|
|
339
|
+
* @property {string} [type] - Type of action to be taken e.g, page.
|
|
335
340
|
* @property {ActionPage} [page]
|
|
336
341
|
* @property {ActionPage} [popup]
|
|
337
342
|
*/
|
|
@@ -561,13 +566,13 @@ const Joi = require("joi");
|
|
|
561
566
|
|
|
562
567
|
/**
|
|
563
568
|
* @typedef Page
|
|
564
|
-
* @property {number} [item_total]
|
|
565
|
-
* @property {string} [next_id]
|
|
566
|
-
* @property {boolean} [has_previous]
|
|
567
|
-
* @property {boolean} [has_next]
|
|
568
|
-
* @property {number} [current]
|
|
569
|
-
* @property {string} type
|
|
570
|
-
* @property {number} [size]
|
|
569
|
+
* @property {number} [item_total] - The total number of items on the page.
|
|
570
|
+
* @property {string} [next_id] - The identifier for the next page.
|
|
571
|
+
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
572
|
+
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
573
|
+
* @property {number} [current] - The current page number.
|
|
574
|
+
* @property {string} type - The type of the page, such as 'PageType'.
|
|
575
|
+
* @property {number} [size] - The number of items per page.
|
|
571
576
|
*/
|
|
572
577
|
|
|
573
578
|
/**
|
|
@@ -757,7 +762,6 @@ const Joi = require("joi");
|
|
|
757
762
|
* @typedef Support
|
|
758
763
|
* @property {boolean} [created]
|
|
759
764
|
* @property {string} [_id]
|
|
760
|
-
* @property {string} [config_type]
|
|
761
765
|
* @property {string} [application]
|
|
762
766
|
* @property {string} [created_at]
|
|
763
767
|
* @property {string} [updated_at]
|
|
@@ -769,6 +773,7 @@ const Joi = require("joi");
|
|
|
769
773
|
* @property {string} [key]
|
|
770
774
|
* @property {string} [code]
|
|
771
775
|
* @property {string} [number]
|
|
776
|
+
* @property {string} [phone_type]
|
|
772
777
|
*/
|
|
773
778
|
|
|
774
779
|
/**
|
|
@@ -1327,9 +1332,9 @@ const Joi = require("joi");
|
|
|
1327
1332
|
|
|
1328
1333
|
/**
|
|
1329
1334
|
* @typedef ActionPage
|
|
1330
|
-
* @property {Object} [params]
|
|
1331
|
-
* @property {Object} [query]
|
|
1332
|
-
* @property {string} [url]
|
|
1335
|
+
* @property {Object} [params] - Parameters that should be considered in path.
|
|
1336
|
+
* @property {Object} [query] - Query parameter if any to be added to the action.
|
|
1337
|
+
* @property {string} [url] - The URL for the action.
|
|
1333
1338
|
* @property {PageType} type
|
|
1334
1339
|
*/
|
|
1335
1340
|
|
|
@@ -1347,6 +1352,7 @@ const Joi = require("joi");
|
|
|
1347
1352
|
* | "category"
|
|
1348
1353
|
* | "collection"
|
|
1349
1354
|
* | "collections"
|
|
1355
|
+
* | "custom"
|
|
1350
1356
|
* | "contact-us"
|
|
1351
1357
|
* | "external"
|
|
1352
1358
|
* | "faq"
|
|
@@ -1611,7 +1617,14 @@ class ContentPlatformModel {
|
|
|
1611
1617
|
return Joi.object({
|
|
1612
1618
|
items: Joi.array().items(ContentPlatformModel.BlogSchema()),
|
|
1613
1619
|
page: ContentPlatformModel.Page(),
|
|
1614
|
-
filters:
|
|
1620
|
+
filters: ContentPlatformModel.BlogFilters(),
|
|
1621
|
+
});
|
|
1622
|
+
}
|
|
1623
|
+
|
|
1624
|
+
/** @returns {BlogFilters} */
|
|
1625
|
+
static BlogFilters() {
|
|
1626
|
+
return Joi.object({
|
|
1627
|
+
tags: Joi.array().items(Joi.string().allow("")),
|
|
1615
1628
|
});
|
|
1616
1629
|
}
|
|
1617
1630
|
|
|
@@ -2326,7 +2339,6 @@ class ContentPlatformModel {
|
|
|
2326
2339
|
return Joi.object({
|
|
2327
2340
|
created: Joi.boolean(),
|
|
2328
2341
|
_id: Joi.string().allow(""),
|
|
2329
|
-
config_type: Joi.string().allow(""),
|
|
2330
2342
|
application: Joi.string().allow(""),
|
|
2331
2343
|
created_at: Joi.string().allow(""),
|
|
2332
2344
|
updated_at: Joi.string().allow(""),
|
|
@@ -2340,6 +2352,7 @@ class ContentPlatformModel {
|
|
|
2340
2352
|
key: Joi.string().allow(""),
|
|
2341
2353
|
code: Joi.string().allow(""),
|
|
2342
2354
|
number: Joi.string().allow(""),
|
|
2355
|
+
phone_type: Joi.string().allow(""),
|
|
2343
2356
|
});
|
|
2344
2357
|
}
|
|
2345
2358
|
|
|
@@ -3113,6 +3126,8 @@ class ContentPlatformModel {
|
|
|
3113
3126
|
|
|
3114
3127
|
"collections",
|
|
3115
3128
|
|
|
3129
|
+
"custom",
|
|
3130
|
+
|
|
3116
3131
|
"contact-us",
|
|
3117
3132
|
|
|
3118
3133
|
"external",
|
|
@@ -140,13 +140,13 @@ export = DiscountPlatformModel;
|
|
|
140
140
|
*/
|
|
141
141
|
/**
|
|
142
142
|
* @typedef Page
|
|
143
|
-
* @property {number} [item_total]
|
|
144
|
-
* @property {string} [next_id]
|
|
145
|
-
* @property {boolean} [has_previous]
|
|
146
|
-
* @property {boolean} [has_next]
|
|
147
|
-
* @property {number} [current]
|
|
148
|
-
* @property {string} type
|
|
149
|
-
* @property {number} [size]
|
|
143
|
+
* @property {number} [item_total] - The total number of items on the page.
|
|
144
|
+
* @property {string} [next_id] - The identifier for the next page.
|
|
145
|
+
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
146
|
+
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
147
|
+
* @property {number} [current] - The current page number.
|
|
148
|
+
* @property {string} type - The type of the page, such as 'PageType'.
|
|
149
|
+
* @property {number} [size] - The number of items per page.
|
|
150
150
|
*/
|
|
151
151
|
/**
|
|
152
152
|
* @typedef UserDetails
|
|
@@ -338,12 +338,33 @@ type CancelJobResponse = {
|
|
|
338
338
|
/** @returns {Page} */
|
|
339
339
|
declare function Page(): Page;
|
|
340
340
|
type Page = {
|
|
341
|
+
/**
|
|
342
|
+
* - The total number of items on the page.
|
|
343
|
+
*/
|
|
341
344
|
item_total?: number;
|
|
345
|
+
/**
|
|
346
|
+
* - The identifier for the next page.
|
|
347
|
+
*/
|
|
342
348
|
next_id?: string;
|
|
349
|
+
/**
|
|
350
|
+
* - Indicates whether there is a previous page.
|
|
351
|
+
*/
|
|
343
352
|
has_previous?: boolean;
|
|
353
|
+
/**
|
|
354
|
+
* - Indicates whether there is a next page.
|
|
355
|
+
*/
|
|
344
356
|
has_next?: boolean;
|
|
357
|
+
/**
|
|
358
|
+
* - The current page number.
|
|
359
|
+
*/
|
|
345
360
|
current?: number;
|
|
361
|
+
/**
|
|
362
|
+
* - The type of the page, such as 'PageType'.
|
|
363
|
+
*/
|
|
346
364
|
type: string;
|
|
365
|
+
/**
|
|
366
|
+
* - The number of items per page.
|
|
367
|
+
*/
|
|
347
368
|
size?: number;
|
|
348
369
|
};
|
|
349
370
|
/** @returns {UserDetails} */
|
|
@@ -153,13 +153,13 @@ const Joi = require("joi");
|
|
|
153
153
|
|
|
154
154
|
/**
|
|
155
155
|
* @typedef Page
|
|
156
|
-
* @property {number} [item_total]
|
|
157
|
-
* @property {string} [next_id]
|
|
158
|
-
* @property {boolean} [has_previous]
|
|
159
|
-
* @property {boolean} [has_next]
|
|
160
|
-
* @property {number} [current]
|
|
161
|
-
* @property {string} type
|
|
162
|
-
* @property {number} [size]
|
|
156
|
+
* @property {number} [item_total] - The total number of items on the page.
|
|
157
|
+
* @property {string} [next_id] - The identifier for the next page.
|
|
158
|
+
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
159
|
+
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
160
|
+
* @property {number} [current] - The current page number.
|
|
161
|
+
* @property {string} type - The type of the page, such as 'PageType'.
|
|
162
|
+
* @property {number} [size] - The number of items per page.
|
|
163
163
|
*/
|
|
164
164
|
|
|
165
165
|
/**
|
|
@@ -152,27 +152,33 @@ export = FileStoragePlatformModel;
|
|
|
152
152
|
*/
|
|
153
153
|
/**
|
|
154
154
|
* @typedef CompanyDetail
|
|
155
|
-
* @property {string} [name]
|
|
156
|
-
* @property {string} [address]
|
|
157
|
-
* @property {string} [city]
|
|
158
|
-
* @property {string} [state]
|
|
159
|
-
* @property {string} [country]
|
|
160
|
-
* @property {number} [zip_code]
|
|
161
|
-
* @property {string} [state_code]
|
|
162
|
-
*
|
|
163
|
-
* @property {string} [
|
|
164
|
-
* @property {string} [
|
|
165
|
-
*
|
|
166
|
-
* @property {string} [
|
|
167
|
-
*
|
|
168
|
-
* @property {string} [
|
|
169
|
-
* @property {string} [
|
|
170
|
-
*
|
|
171
|
-
* @property {
|
|
172
|
-
* @property {string} [
|
|
173
|
-
* @property {string} [
|
|
174
|
-
* @property {string} [
|
|
175
|
-
* @property {Object} [
|
|
155
|
+
* @property {string} [name] - The official name of the company.
|
|
156
|
+
* @property {string} [address] - The physical street address of the company.
|
|
157
|
+
* @property {string} [city] - The city where the company is located.
|
|
158
|
+
* @property {string} [state] - The state or province where the company is located.
|
|
159
|
+
* @property {string} [country] - The country where the company is based.
|
|
160
|
+
* @property {number} [zip_code] - The postal code for the company's location.
|
|
161
|
+
* @property {string} [state_code] - A code representing the state, often used
|
|
162
|
+
* in official documents and forms.
|
|
163
|
+
* @property {string} [country_code] - The code of the country.
|
|
164
|
+
* @property {string} [gstin] - The Goods and Services Tax Identification
|
|
165
|
+
* Number, unique to each business in India.
|
|
166
|
+
* @property {string} [pan] - The Permanent Account Number, unique to each
|
|
167
|
+
* taxpayer in India.
|
|
168
|
+
* @property {string} [phone_no] - The primary contact phone number for the company.
|
|
169
|
+
* @property {string} [cin] - The Corporate Identification Number, unique to
|
|
170
|
+
* each company registered in India.
|
|
171
|
+
* @property {string} [website_url] - The URL to the company's official website.
|
|
172
|
+
* @property {string} [email] - The company's official email address.
|
|
173
|
+
* @property {string} [display_address] - The display address of the company.
|
|
174
|
+
* @property {string} [sector] - The sector in which company is located.
|
|
175
|
+
* @property {Object} [phone] - The provided phone no of country.
|
|
176
|
+
* @property {string} [trn] - The trn no of the company.
|
|
177
|
+
* @property {string} [vat] - The vat no of the company.
|
|
178
|
+
* @property {string} [business_country_timezone] - The bussiness country timezone.
|
|
179
|
+
* @property {Object} [business_country_currency] - This object represents the
|
|
180
|
+
* bussiness country currency.
|
|
181
|
+
* @property {Object} [meta] - This object represents the meta fields for company.
|
|
176
182
|
*/
|
|
177
183
|
/**
|
|
178
184
|
* @typedef StoreDetail
|
|
@@ -412,6 +418,8 @@ export = FileStoragePlatformModel;
|
|
|
412
418
|
* @property {boolean} [is_self_ship]
|
|
413
419
|
* @property {string} [mode]
|
|
414
420
|
* @property {boolean} [is_self_pickup]
|
|
421
|
+
* @property {Object} [shipment_meta] - This field represents the shipment meta details
|
|
422
|
+
* @property {Object} [order_meta] - This field represents the order meta details
|
|
415
423
|
* @property {string} [platform_name]
|
|
416
424
|
* @property {number} [amount_to_be_collected]
|
|
417
425
|
* @property {number} [amount_paid]
|
|
@@ -427,11 +435,12 @@ export = FileStoragePlatformModel;
|
|
|
427
435
|
*/
|
|
428
436
|
/**
|
|
429
437
|
* @typedef DummyTemplateData
|
|
430
|
-
* @property {string} [_id]
|
|
431
|
-
*
|
|
438
|
+
* @property {string} [_id] - This field contains the unique identifier for the
|
|
439
|
+
* PDF payload.
|
|
440
|
+
* @property {number} [pdf_type_id] - This is invoice unique id
|
|
432
441
|
* @property {DummyTemplateDataPayload} payload
|
|
433
|
-
* @property {string} [country_code]
|
|
434
|
-
* @property {number} [__v]
|
|
442
|
+
* @property {string} [country_code] - This field represents the country code.
|
|
443
|
+
* @property {number} [__v] - This field holds the version number.
|
|
435
444
|
*/
|
|
436
445
|
/**
|
|
437
446
|
* @typedef DummyTemplateDataItems
|
|
@@ -741,27 +750,99 @@ type InvoiceDetail = {
|
|
|
741
750
|
/** @returns {CompanyDetail} */
|
|
742
751
|
declare function CompanyDetail(): CompanyDetail;
|
|
743
752
|
type CompanyDetail = {
|
|
753
|
+
/**
|
|
754
|
+
* - The official name of the company.
|
|
755
|
+
*/
|
|
744
756
|
name?: string;
|
|
757
|
+
/**
|
|
758
|
+
* - The physical street address of the company.
|
|
759
|
+
*/
|
|
745
760
|
address?: string;
|
|
761
|
+
/**
|
|
762
|
+
* - The city where the company is located.
|
|
763
|
+
*/
|
|
746
764
|
city?: string;
|
|
765
|
+
/**
|
|
766
|
+
* - The state or province where the company is located.
|
|
767
|
+
*/
|
|
747
768
|
state?: string;
|
|
769
|
+
/**
|
|
770
|
+
* - The country where the company is based.
|
|
771
|
+
*/
|
|
748
772
|
country?: string;
|
|
773
|
+
/**
|
|
774
|
+
* - The postal code for the company's location.
|
|
775
|
+
*/
|
|
749
776
|
zip_code?: number;
|
|
777
|
+
/**
|
|
778
|
+
* - A code representing the state, often used
|
|
779
|
+
* in official documents and forms.
|
|
780
|
+
*/
|
|
750
781
|
state_code?: string;
|
|
782
|
+
/**
|
|
783
|
+
* - The code of the country.
|
|
784
|
+
*/
|
|
751
785
|
country_code?: string;
|
|
786
|
+
/**
|
|
787
|
+
* - The Goods and Services Tax Identification
|
|
788
|
+
* Number, unique to each business in India.
|
|
789
|
+
*/
|
|
752
790
|
gstin?: string;
|
|
791
|
+
/**
|
|
792
|
+
* - The Permanent Account Number, unique to each
|
|
793
|
+
* taxpayer in India.
|
|
794
|
+
*/
|
|
753
795
|
pan?: string;
|
|
796
|
+
/**
|
|
797
|
+
* - The primary contact phone number for the company.
|
|
798
|
+
*/
|
|
754
799
|
phone_no?: string;
|
|
800
|
+
/**
|
|
801
|
+
* - The Corporate Identification Number, unique to
|
|
802
|
+
* each company registered in India.
|
|
803
|
+
*/
|
|
755
804
|
cin?: string;
|
|
805
|
+
/**
|
|
806
|
+
* - The URL to the company's official website.
|
|
807
|
+
*/
|
|
756
808
|
website_url?: string;
|
|
809
|
+
/**
|
|
810
|
+
* - The company's official email address.
|
|
811
|
+
*/
|
|
757
812
|
email?: string;
|
|
813
|
+
/**
|
|
814
|
+
* - The display address of the company.
|
|
815
|
+
*/
|
|
758
816
|
display_address?: string;
|
|
817
|
+
/**
|
|
818
|
+
* - The sector in which company is located.
|
|
819
|
+
*/
|
|
759
820
|
sector?: string;
|
|
821
|
+
/**
|
|
822
|
+
* - The provided phone no of country.
|
|
823
|
+
*/
|
|
760
824
|
phone?: any;
|
|
825
|
+
/**
|
|
826
|
+
* - The trn no of the company.
|
|
827
|
+
*/
|
|
761
828
|
trn?: string;
|
|
829
|
+
/**
|
|
830
|
+
* - The vat no of the company.
|
|
831
|
+
*/
|
|
762
832
|
vat?: string;
|
|
833
|
+
/**
|
|
834
|
+
* - The bussiness country timezone.
|
|
835
|
+
*/
|
|
763
836
|
business_country_timezone?: string;
|
|
837
|
+
/**
|
|
838
|
+
* - This object represents the
|
|
839
|
+
* bussiness country currency.
|
|
840
|
+
*/
|
|
764
841
|
business_country_currency?: any;
|
|
842
|
+
/**
|
|
843
|
+
* - This object represents the meta fields for company.
|
|
844
|
+
*/
|
|
845
|
+
meta?: any;
|
|
765
846
|
};
|
|
766
847
|
/** @returns {StoreDetail} */
|
|
767
848
|
declare function StoreDetail(): StoreDetail;
|
|
@@ -1027,6 +1108,14 @@ type DummyTemplateDataPayload = {
|
|
|
1027
1108
|
is_self_ship?: boolean;
|
|
1028
1109
|
mode?: string;
|
|
1029
1110
|
is_self_pickup?: boolean;
|
|
1111
|
+
/**
|
|
1112
|
+
* - This field represents the shipment meta details
|
|
1113
|
+
*/
|
|
1114
|
+
shipment_meta?: any;
|
|
1115
|
+
/**
|
|
1116
|
+
* - This field represents the order meta details
|
|
1117
|
+
*/
|
|
1118
|
+
order_meta?: any;
|
|
1030
1119
|
platform_name?: string;
|
|
1031
1120
|
amount_to_be_collected?: number;
|
|
1032
1121
|
amount_paid?: number;
|
|
@@ -1043,10 +1132,23 @@ type DummyTemplateDataPayload = {
|
|
|
1043
1132
|
/** @returns {DummyTemplateData} */
|
|
1044
1133
|
declare function DummyTemplateData(): DummyTemplateData;
|
|
1045
1134
|
type DummyTemplateData = {
|
|
1135
|
+
/**
|
|
1136
|
+
* - This field contains the unique identifier for the
|
|
1137
|
+
* PDF payload.
|
|
1138
|
+
*/
|
|
1046
1139
|
_id?: string;
|
|
1140
|
+
/**
|
|
1141
|
+
* - This is invoice unique id
|
|
1142
|
+
*/
|
|
1047
1143
|
pdf_type_id?: number;
|
|
1048
1144
|
payload: DummyTemplateDataPayload;
|
|
1145
|
+
/**
|
|
1146
|
+
* - This field represents the country code.
|
|
1147
|
+
*/
|
|
1049
1148
|
country_code?: string;
|
|
1149
|
+
/**
|
|
1150
|
+
* - This field holds the version number.
|
|
1151
|
+
*/
|
|
1050
1152
|
__v?: number;
|
|
1051
1153
|
};
|
|
1052
1154
|
/** @returns {DummyTemplateDataItems} */
|