@gofynd/fdk-client-javascript 1.4.15 → 1.4.16-beta.1
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 +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +11 -11
- package/sdk/application/Cart/CartApplicationClient.js +343 -48
- package/sdk/application/Catalog/CatalogApplicationClient.js +408 -0
- package/sdk/application/Common/CommonApplicationClient.js +21 -0
- package/sdk/application/Communication/CommunicationApplicationClient.js +29 -0
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +147 -0
- package/sdk/application/Content/ContentApplicationClient.d.ts +20 -0
- package/sdk/application/Content/ContentApplicationClient.js +327 -0
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +43 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +21 -0
- package/sdk/application/Lead/LeadApplicationClient.js +73 -0
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.js +182 -2
- package/sdk/application/Order/OrderApplicationClient.js +202 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +0 -10
- package/sdk/application/Payment/PaymentApplicationClient.js +445 -38
- package/sdk/application/Rewards/RewardsApplicationClient.js +68 -0
- package/sdk/application/Share/ShareApplicationClient.js +96 -0
- package/sdk/application/Theme/ThemeApplicationClient.js +64 -0
- package/sdk/application/User/UserApplicationClient.js +412 -0
- package/sdk/application/Webhook/WebhookApplicationClient.js +13 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +12 -33
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +38 -209
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +19 -399
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +11 -212
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -3
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +7 -22
- package/sdk/partner/OAuthClient.js +1 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +3 -40
- package/sdk/partner/Theme/ThemePartnerModel.js +2 -24
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +12 -3
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +11 -1
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +4 -1
- package/sdk/platform/Cart/CartPlatformModel.d.ts +14 -28
- package/sdk/platform/Cart/CartPlatformModel.js +7 -13
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +0 -24
- package/sdk/platform/Catalog/CatalogPlatformClient.js +0 -176
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +29 -80
- package/sdk/platform/Catalog/CatalogPlatformModel.js +32 -72
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1 -45
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +0 -35
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +7 -0
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +3 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +52 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +411 -0
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +85 -1
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +73 -0
- package/sdk/platform/Content/ContentPlatformModel.d.ts +90 -1
- package/sdk/platform/Content/ContentPlatformModel.js +104 -0
- package/sdk/platform/Order/OrderPlatformClient.d.ts +2 -2
- package/sdk/platform/Order/OrderPlatformClient.js +0 -8
- package/sdk/platform/Order/OrderPlatformModel.d.ts +3 -75
- package/sdk/platform/Order/OrderPlatformModel.js +2 -43
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +0 -22
- package/sdk/platform/Order/OrderPlatformValidator.js +0 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +10 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +118 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +53 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +29 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +0 -104
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +74 -816
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +23 -598
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +20 -382
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +1 -191
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +0 -138
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +3 -40
- package/sdk/platform/Theme/ThemePlatformModel.js +2 -24
- package/sdk/public/Configuration/ConfigurationPublicClient.js +16 -0
- package/sdk/public/Content/ContentPublicClient.js +116 -0
- package/sdk/public/Partner/PartnerPublicClient.js +15 -0
- package/sdk/public/Webhook/WebhookPublicClient.js +40 -0
|
@@ -80,6 +80,11 @@ const ContentPlatformModel = require("./ContentPlatformModel");
|
|
|
80
80
|
* @property {ContentPlatformModel.SEOSchemaMarkupTemplateRequestBody} body
|
|
81
81
|
*/
|
|
82
82
|
|
|
83
|
+
/**
|
|
84
|
+
* @typedef CreateSlideshowParam
|
|
85
|
+
* @property {ContentPlatformModel.SlideshowPayload} body
|
|
86
|
+
*/
|
|
87
|
+
|
|
83
88
|
/**
|
|
84
89
|
* @typedef DeleteAnnouncementParam
|
|
85
90
|
* @property {string} announcementId - ID allotted to the announcement.
|
|
@@ -150,6 +155,11 @@ const ContentPlatformModel = require("./ContentPlatformModel");
|
|
|
150
155
|
* Template created within a business.
|
|
151
156
|
*/
|
|
152
157
|
|
|
158
|
+
/**
|
|
159
|
+
* @typedef DeleteSlideshowParam
|
|
160
|
+
* @property {string} id - ID allotted to the slideshow.
|
|
161
|
+
*/
|
|
162
|
+
|
|
153
163
|
/**
|
|
154
164
|
* @typedef EditDataLoaderParam
|
|
155
165
|
* @property {string} dataLoaderId - ID allotted to the data loader.
|
|
@@ -405,6 +415,24 @@ const ContentPlatformModel = require("./ContentPlatformModel");
|
|
|
405
415
|
* Default value is 10.
|
|
406
416
|
*/
|
|
407
417
|
|
|
418
|
+
/**
|
|
419
|
+
* @typedef GetSlideshowBySlugParam
|
|
420
|
+
* @property {string} slug - A short, human-readable, URL-friendly identifier of
|
|
421
|
+
* a slideshow. You can get slug value of a page from `getSlideshows` API.
|
|
422
|
+
* @property {string} devicePlatform - Filter slideshows by platform. Acceptable
|
|
423
|
+
* values are: web, android, ios and all
|
|
424
|
+
*/
|
|
425
|
+
|
|
426
|
+
/**
|
|
427
|
+
* @typedef GetSlideshowsParam
|
|
428
|
+
* @property {string} devicePlatform - Filter slideshows by platform. Acceptable
|
|
429
|
+
* values are: web, android, ios and all
|
|
430
|
+
* @property {number} [pageNo] - The page number to navigate through the given
|
|
431
|
+
* set of results. Default value is 1.
|
|
432
|
+
* @property {number} [pageSize] - The number of items to retrieve in each page.
|
|
433
|
+
* Default value is 10.
|
|
434
|
+
*/
|
|
435
|
+
|
|
408
436
|
/** @typedef GetSupportInformationParam */
|
|
409
437
|
|
|
410
438
|
/**
|
|
@@ -539,6 +567,12 @@ const ContentPlatformModel = require("./ContentPlatformModel");
|
|
|
539
567
|
* @property {ContentPlatformModel.SeoComponent} body
|
|
540
568
|
*/
|
|
541
569
|
|
|
570
|
+
/**
|
|
571
|
+
* @typedef UpdateSlideshowParam
|
|
572
|
+
* @property {string} id - ID allotted to the slideshow.
|
|
573
|
+
* @property {ContentPlatformModel.SlideshowPayload} body
|
|
574
|
+
*/
|
|
575
|
+
|
|
542
576
|
/**
|
|
543
577
|
* @typedef UpdateSupportInformationParam
|
|
544
578
|
* @property {ContentPlatformModel.Support} body
|
|
@@ -653,6 +687,13 @@ class ContentPlatformApplicationValidator {
|
|
|
653
687
|
}).required();
|
|
654
688
|
}
|
|
655
689
|
|
|
690
|
+
/** @returns {CreateSlideshowParam} */
|
|
691
|
+
static createSlideshow() {
|
|
692
|
+
return Joi.object({
|
|
693
|
+
body: ContentPlatformModel.SlideshowPayload().required(),
|
|
694
|
+
}).required();
|
|
695
|
+
}
|
|
696
|
+
|
|
656
697
|
/** @returns {DeleteAnnouncementParam} */
|
|
657
698
|
static deleteAnnouncement() {
|
|
658
699
|
return Joi.object({
|
|
@@ -748,6 +789,13 @@ class ContentPlatformApplicationValidator {
|
|
|
748
789
|
}).required();
|
|
749
790
|
}
|
|
750
791
|
|
|
792
|
+
/** @returns {DeleteSlideshowParam} */
|
|
793
|
+
static deleteSlideshow() {
|
|
794
|
+
return Joi.object({
|
|
795
|
+
id: Joi.string().allow("").required(),
|
|
796
|
+
}).required();
|
|
797
|
+
}
|
|
798
|
+
|
|
751
799
|
/** @returns {EditDataLoaderParam} */
|
|
752
800
|
static editDataLoader() {
|
|
753
801
|
return Joi.object({
|
|
@@ -1066,6 +1114,23 @@ class ContentPlatformApplicationValidator {
|
|
|
1066
1114
|
}).required();
|
|
1067
1115
|
}
|
|
1068
1116
|
|
|
1117
|
+
/** @returns {GetSlideshowBySlugParam} */
|
|
1118
|
+
static getSlideshowBySlug() {
|
|
1119
|
+
return Joi.object({
|
|
1120
|
+
slug: Joi.string().allow("").required(),
|
|
1121
|
+
devicePlatform: Joi.string().allow("").required(),
|
|
1122
|
+
}).required();
|
|
1123
|
+
}
|
|
1124
|
+
|
|
1125
|
+
/** @returns {GetSlideshowsParam} */
|
|
1126
|
+
static getSlideshows() {
|
|
1127
|
+
return Joi.object({
|
|
1128
|
+
devicePlatform: Joi.string().allow("").required(),
|
|
1129
|
+
pageNo: Joi.number(),
|
|
1130
|
+
pageSize: Joi.number(),
|
|
1131
|
+
}).required();
|
|
1132
|
+
}
|
|
1133
|
+
|
|
1069
1134
|
/** @returns {GetSupportInformationParam} */
|
|
1070
1135
|
static getSupportInformation() {
|
|
1071
1136
|
return Joi.object({}).required();
|
|
@@ -1246,6 +1311,14 @@ class ContentPlatformApplicationValidator {
|
|
|
1246
1311
|
}).required();
|
|
1247
1312
|
}
|
|
1248
1313
|
|
|
1314
|
+
/** @returns {UpdateSlideshowParam} */
|
|
1315
|
+
static updateSlideshow() {
|
|
1316
|
+
return Joi.object({
|
|
1317
|
+
id: Joi.string().allow("").required(),
|
|
1318
|
+
body: ContentPlatformModel.SlideshowPayload().required(),
|
|
1319
|
+
}).required();
|
|
1320
|
+
}
|
|
1321
|
+
|
|
1249
1322
|
/** @returns {UpdateSupportInformationParam} */
|
|
1250
1323
|
static updateSupportInformation() {
|
|
1251
1324
|
return Joi.object({
|
|
@@ -324,6 +324,22 @@ export = ContentPlatformModel;
|
|
|
324
324
|
* @property {string} [start]
|
|
325
325
|
* @property {string} [end]
|
|
326
326
|
*/
|
|
327
|
+
/**
|
|
328
|
+
* @typedef ConfigurationSchema
|
|
329
|
+
* @property {number} [sleep_time]
|
|
330
|
+
* @property {boolean} [start_on_launch]
|
|
331
|
+
* @property {number} [duration]
|
|
332
|
+
* @property {string} [slide_direction]
|
|
333
|
+
*/
|
|
334
|
+
/**
|
|
335
|
+
* @typedef SlideshowMedia
|
|
336
|
+
* @property {string} [type]
|
|
337
|
+
* @property {string} [url]
|
|
338
|
+
* @property {string} [bg_color]
|
|
339
|
+
* @property {number} [duration]
|
|
340
|
+
* @property {boolean} [auto_decide_duration]
|
|
341
|
+
* @property {Action} [action]
|
|
342
|
+
*/
|
|
327
343
|
/**
|
|
328
344
|
* @typedef UpdateHandpickedSchema
|
|
329
345
|
* @property {HandpickedTagSchema} [tag]
|
|
@@ -628,6 +644,32 @@ export = ContentPlatformModel;
|
|
|
628
644
|
* @property {PageSchema[]} [custom_pages]
|
|
629
645
|
* @property {string} [application_id]
|
|
630
646
|
*/
|
|
647
|
+
/**
|
|
648
|
+
* @typedef SlideshowGetDetails
|
|
649
|
+
* @property {SlideshowSchema[]} [items]
|
|
650
|
+
* @property {Page} [page]
|
|
651
|
+
*/
|
|
652
|
+
/**
|
|
653
|
+
* @typedef SlideshowSchema
|
|
654
|
+
* @property {string} [_id]
|
|
655
|
+
* @property {string} [slug]
|
|
656
|
+
* @property {DateMeta} [date_meta]
|
|
657
|
+
* @property {string} [application]
|
|
658
|
+
* @property {string} [platform]
|
|
659
|
+
* @property {ConfigurationSchema} [configuration]
|
|
660
|
+
* @property {SlideshowMedia[]} [media]
|
|
661
|
+
* @property {boolean} [active]
|
|
662
|
+
* @property {boolean} [archived]
|
|
663
|
+
* @property {Object} [_custom_json]
|
|
664
|
+
*/
|
|
665
|
+
/**
|
|
666
|
+
* @typedef SlideshowPayload
|
|
667
|
+
* @property {string} [slug]
|
|
668
|
+
* @property {string} [platform]
|
|
669
|
+
* @property {ConfigurationSchema} [configuration]
|
|
670
|
+
* @property {SlideshowMedia} [media]
|
|
671
|
+
* @property {boolean} [active]
|
|
672
|
+
*/
|
|
631
673
|
/**
|
|
632
674
|
* @typedef Support
|
|
633
675
|
* @property {boolean} [created]
|
|
@@ -1256,7 +1298,7 @@ export = ContentPlatformModel;
|
|
|
1256
1298
|
declare class ContentPlatformModel {
|
|
1257
1299
|
}
|
|
1258
1300
|
declare namespace ContentPlatformModel {
|
|
1259
|
-
export { ValidationError, GenerateSEOContent, GeneratedSEOContent, ApplicationLegal, ApplicationLegalFAQ, PathMappingSchema, PathSourceSchema, SeoComponent, SeoSchema, CustomMetaTag, Detail, SeoSchemaComponent, SEOSchemaMarkupTemplate, SEOSchemaMarkupTemplateRequestBody, AnnouncementPageSchema, EditorMeta, AnnouncementAuthorSchema, AdminAnnouncementSchema, DefaultSchemaComponent, DefaultSEOSchemaMarkupTemplate, ScheduleSchema, NextSchedule, BlogGetDetails, BlogFilters, ResourceContent, Asset, Author, BlogSchema, SEO, SEOImage, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, DateMeta, BlogPayload, GetAnnouncementListSchema, CreateAnnouncementSchema, DataLoaderResponseSchema, DataLoaderResetResponseSchema, LocaleLanguage, Language, Action, NavigationReference, CronBasedScheduleSchema, UpdateHandpickedSchema, HandpickedTagSchema, RemoveHandpickedSchema, CreateTagSchema, CreateTagRequestSchema, DataLoaderSchema, DataLoaderSourceSchema, DataLoadersSchema, TagDeleteSuccessDetails, ContentAPIError, CommonError, CategorySchema, ChildrenSchema, CategoryRequestSchema, FAQCategorySchema, FaqSchema, FAQ, CreateFaqResponseSchema, CreateFaqSchema, GetFaqSchema, UpdateFaqCategoryRequestSchema, CreateFaqCategoryRequestSchema, CreateFaqCategorySchema, GetFaqCategoriesSchema, GetFaqCategoryBySlugSchema, Page, LandingPageGetDetails, LandingPageSchema, DefaultNavigationDetails, NavigationGetDetails, Orientation, NavigationSchema, NavigationPayload, PageGetDetails, PageSpec, PageSpecParam, PageSpecItem, PageSchema, CreatedBySchema, PagePayload, CronSchedule, PagePublishPayload, PageMetaSchema, Support, PhoneProperties, PhoneSchema, EmailProperties, EmailSchema, ContactSchema, TagsSchema, TagSchema, TagSourceSchema, ResourcesSchema, ResourceSchema, FieldValidations, FieldDefinitionSchema, CustomFieldDefinitionsSchema, CustomFieldDefinitionRequestSchema, CustomObjectCustomFieldDefinitions, CustomObjectDefinitionUpdateRequestSchema, CustomFieldDefinitionDetailResSchema, MetaFieldDefinitionDetailResSchema, CustomDataDeleteSchema, CustomFieldValue, CustomFieldSchema, CustomFieldsResponseSchema, CustomFieldsDeleteSchema, CustomFieldsResponseByResourceIdSchema, CustomField, CustomFieldRequestSchema, CustomObjectSchema, CustomObjectDefinitionRequestSchema, CustomObjectDefinitionSlugSchema, CustomObjectDefinitionDeleteResponseSchema, CustomObjectEntryBulkUploadDetails, CustomObjectListItemDefinitionModel, CustomObjectListItemSchema, CustomObjectsSchema, CustomObjectFieldDefinition, CustomObjectBySlugSchema, CustomObjectBulkEntryInitiateDownload, CustomObjectMetaSchema, JobSchema, CustomFieldBulkEntry, CustomObjectBulkEntry, MetafieldTypesSchema, CustomFieldTypeSchema, SupportedValidationsMetaExampleSchema, SupportedValidationsMetaSchema, SupportedValidationsSchema, Duration, HTML, StringSingleLine, StringMultiLine, Dropdown, Integer, FloatType, BooleanType, Date, Datetime, Json, File, Url, Metaobject, Product, CustomObjectEntry, CustomObjectDefinitionsSchema, CustomObjectEntryFieldSchema, CustomObjectEntryFieldSchemaWithoutID, CustomObjectRequestSchema, CustomObjectRequestSchemaWithoutId, CustomObjectBulkSchema, ActionPage, GenerationEntityType, PageType };
|
|
1301
|
+
export { ValidationError, GenerateSEOContent, GeneratedSEOContent, ApplicationLegal, ApplicationLegalFAQ, PathMappingSchema, PathSourceSchema, SeoComponent, SeoSchema, CustomMetaTag, Detail, SeoSchemaComponent, SEOSchemaMarkupTemplate, SEOSchemaMarkupTemplateRequestBody, AnnouncementPageSchema, EditorMeta, AnnouncementAuthorSchema, AdminAnnouncementSchema, DefaultSchemaComponent, DefaultSEOSchemaMarkupTemplate, ScheduleSchema, NextSchedule, BlogGetDetails, BlogFilters, ResourceContent, Asset, Author, BlogSchema, SEO, SEOImage, SEOMetaItem, SEOMetaItems, SEOSitemap, SEObreadcrumb, DateMeta, BlogPayload, GetAnnouncementListSchema, CreateAnnouncementSchema, DataLoaderResponseSchema, DataLoaderResetResponseSchema, LocaleLanguage, Language, Action, NavigationReference, CronBasedScheduleSchema, ConfigurationSchema, SlideshowMedia, UpdateHandpickedSchema, HandpickedTagSchema, RemoveHandpickedSchema, CreateTagSchema, CreateTagRequestSchema, DataLoaderSchema, DataLoaderSourceSchema, DataLoadersSchema, TagDeleteSuccessDetails, ContentAPIError, CommonError, CategorySchema, ChildrenSchema, CategoryRequestSchema, FAQCategorySchema, FaqSchema, FAQ, CreateFaqResponseSchema, CreateFaqSchema, GetFaqSchema, UpdateFaqCategoryRequestSchema, CreateFaqCategoryRequestSchema, CreateFaqCategorySchema, GetFaqCategoriesSchema, GetFaqCategoryBySlugSchema, Page, LandingPageGetDetails, LandingPageSchema, DefaultNavigationDetails, NavigationGetDetails, Orientation, NavigationSchema, NavigationPayload, PageGetDetails, PageSpec, PageSpecParam, PageSpecItem, PageSchema, CreatedBySchema, PagePayload, CronSchedule, PagePublishPayload, PageMetaSchema, SlideshowGetDetails, SlideshowSchema, SlideshowPayload, Support, PhoneProperties, PhoneSchema, EmailProperties, EmailSchema, ContactSchema, TagsSchema, TagSchema, TagSourceSchema, ResourcesSchema, ResourceSchema, FieldValidations, FieldDefinitionSchema, CustomFieldDefinitionsSchema, CustomFieldDefinitionRequestSchema, CustomObjectCustomFieldDefinitions, CustomObjectDefinitionUpdateRequestSchema, CustomFieldDefinitionDetailResSchema, MetaFieldDefinitionDetailResSchema, CustomDataDeleteSchema, CustomFieldValue, CustomFieldSchema, CustomFieldsResponseSchema, CustomFieldsDeleteSchema, CustomFieldsResponseByResourceIdSchema, CustomField, CustomFieldRequestSchema, CustomObjectSchema, CustomObjectDefinitionRequestSchema, CustomObjectDefinitionSlugSchema, CustomObjectDefinitionDeleteResponseSchema, CustomObjectEntryBulkUploadDetails, CustomObjectListItemDefinitionModel, CustomObjectListItemSchema, CustomObjectsSchema, CustomObjectFieldDefinition, CustomObjectBySlugSchema, CustomObjectBulkEntryInitiateDownload, CustomObjectMetaSchema, JobSchema, CustomFieldBulkEntry, CustomObjectBulkEntry, MetafieldTypesSchema, CustomFieldTypeSchema, SupportedValidationsMetaExampleSchema, SupportedValidationsMetaSchema, SupportedValidationsSchema, Duration, HTML, StringSingleLine, StringMultiLine, Dropdown, Integer, FloatType, BooleanType, Date, Datetime, Json, File, Url, Metaobject, Product, CustomObjectEntry, CustomObjectDefinitionsSchema, CustomObjectEntryFieldSchema, CustomObjectEntryFieldSchemaWithoutID, CustomObjectRequestSchema, CustomObjectRequestSchemaWithoutId, CustomObjectBulkSchema, ActionPage, GenerationEntityType, PageType };
|
|
1260
1302
|
}
|
|
1261
1303
|
/** @returns {ValidationError} */
|
|
1262
1304
|
declare function ValidationError(): ValidationError;
|
|
@@ -1637,6 +1679,24 @@ type CronBasedScheduleSchema = {
|
|
|
1637
1679
|
start?: string;
|
|
1638
1680
|
end?: string;
|
|
1639
1681
|
};
|
|
1682
|
+
/** @returns {ConfigurationSchema} */
|
|
1683
|
+
declare function ConfigurationSchema(): ConfigurationSchema;
|
|
1684
|
+
type ConfigurationSchema = {
|
|
1685
|
+
sleep_time?: number;
|
|
1686
|
+
start_on_launch?: boolean;
|
|
1687
|
+
duration?: number;
|
|
1688
|
+
slide_direction?: string;
|
|
1689
|
+
};
|
|
1690
|
+
/** @returns {SlideshowMedia} */
|
|
1691
|
+
declare function SlideshowMedia(): SlideshowMedia;
|
|
1692
|
+
type SlideshowMedia = {
|
|
1693
|
+
type?: string;
|
|
1694
|
+
url?: string;
|
|
1695
|
+
bg_color?: string;
|
|
1696
|
+
duration?: number;
|
|
1697
|
+
auto_decide_duration?: boolean;
|
|
1698
|
+
action?: Action;
|
|
1699
|
+
};
|
|
1640
1700
|
/** @returns {UpdateHandpickedSchema} */
|
|
1641
1701
|
declare function UpdateHandpickedSchema(): UpdateHandpickedSchema;
|
|
1642
1702
|
type UpdateHandpickedSchema = {
|
|
@@ -2008,6 +2068,35 @@ type PageMetaSchema = {
|
|
|
2008
2068
|
custom_pages?: PageSchema[];
|
|
2009
2069
|
application_id?: string;
|
|
2010
2070
|
};
|
|
2071
|
+
/** @returns {SlideshowGetDetails} */
|
|
2072
|
+
declare function SlideshowGetDetails(): SlideshowGetDetails;
|
|
2073
|
+
type SlideshowGetDetails = {
|
|
2074
|
+
items?: SlideshowSchema[];
|
|
2075
|
+
page?: Page;
|
|
2076
|
+
};
|
|
2077
|
+
/** @returns {SlideshowSchema} */
|
|
2078
|
+
declare function SlideshowSchema(): SlideshowSchema;
|
|
2079
|
+
type SlideshowSchema = {
|
|
2080
|
+
_id?: string;
|
|
2081
|
+
slug?: string;
|
|
2082
|
+
date_meta?: DateMeta;
|
|
2083
|
+
application?: string;
|
|
2084
|
+
platform?: string;
|
|
2085
|
+
configuration?: ConfigurationSchema;
|
|
2086
|
+
media?: SlideshowMedia[];
|
|
2087
|
+
active?: boolean;
|
|
2088
|
+
archived?: boolean;
|
|
2089
|
+
_custom_json?: any;
|
|
2090
|
+
};
|
|
2091
|
+
/** @returns {SlideshowPayload} */
|
|
2092
|
+
declare function SlideshowPayload(): SlideshowPayload;
|
|
2093
|
+
type SlideshowPayload = {
|
|
2094
|
+
slug?: string;
|
|
2095
|
+
platform?: string;
|
|
2096
|
+
configuration?: ConfigurationSchema;
|
|
2097
|
+
media?: SlideshowMedia;
|
|
2098
|
+
active?: boolean;
|
|
2099
|
+
};
|
|
2011
2100
|
/** @returns {Support} */
|
|
2012
2101
|
declare function Support(): Support;
|
|
2013
2102
|
type Support = {
|
|
@@ -370,6 +370,24 @@ const Joi = require("joi");
|
|
|
370
370
|
* @property {string} [end]
|
|
371
371
|
*/
|
|
372
372
|
|
|
373
|
+
/**
|
|
374
|
+
* @typedef ConfigurationSchema
|
|
375
|
+
* @property {number} [sleep_time]
|
|
376
|
+
* @property {boolean} [start_on_launch]
|
|
377
|
+
* @property {number} [duration]
|
|
378
|
+
* @property {string} [slide_direction]
|
|
379
|
+
*/
|
|
380
|
+
|
|
381
|
+
/**
|
|
382
|
+
* @typedef SlideshowMedia
|
|
383
|
+
* @property {string} [type]
|
|
384
|
+
* @property {string} [url]
|
|
385
|
+
* @property {string} [bg_color]
|
|
386
|
+
* @property {number} [duration]
|
|
387
|
+
* @property {boolean} [auto_decide_duration]
|
|
388
|
+
* @property {Action} [action]
|
|
389
|
+
*/
|
|
390
|
+
|
|
373
391
|
/**
|
|
374
392
|
* @typedef UpdateHandpickedSchema
|
|
375
393
|
* @property {HandpickedTagSchema} [tag]
|
|
@@ -717,6 +735,35 @@ const Joi = require("joi");
|
|
|
717
735
|
* @property {string} [application_id]
|
|
718
736
|
*/
|
|
719
737
|
|
|
738
|
+
/**
|
|
739
|
+
* @typedef SlideshowGetDetails
|
|
740
|
+
* @property {SlideshowSchema[]} [items]
|
|
741
|
+
* @property {Page} [page]
|
|
742
|
+
*/
|
|
743
|
+
|
|
744
|
+
/**
|
|
745
|
+
* @typedef SlideshowSchema
|
|
746
|
+
* @property {string} [_id]
|
|
747
|
+
* @property {string} [slug]
|
|
748
|
+
* @property {DateMeta} [date_meta]
|
|
749
|
+
* @property {string} [application]
|
|
750
|
+
* @property {string} [platform]
|
|
751
|
+
* @property {ConfigurationSchema} [configuration]
|
|
752
|
+
* @property {SlideshowMedia[]} [media]
|
|
753
|
+
* @property {boolean} [active]
|
|
754
|
+
* @property {boolean} [archived]
|
|
755
|
+
* @property {Object} [_custom_json]
|
|
756
|
+
*/
|
|
757
|
+
|
|
758
|
+
/**
|
|
759
|
+
* @typedef SlideshowPayload
|
|
760
|
+
* @property {string} [slug]
|
|
761
|
+
* @property {string} [platform]
|
|
762
|
+
* @property {ConfigurationSchema} [configuration]
|
|
763
|
+
* @property {SlideshowMedia} [media]
|
|
764
|
+
* @property {boolean} [active]
|
|
765
|
+
*/
|
|
766
|
+
|
|
720
767
|
/**
|
|
721
768
|
* @typedef Support
|
|
722
769
|
* @property {boolean} [created]
|
|
@@ -1877,6 +1924,28 @@ class ContentPlatformModel {
|
|
|
1877
1924
|
});
|
|
1878
1925
|
}
|
|
1879
1926
|
|
|
1927
|
+
/** @returns {ConfigurationSchema} */
|
|
1928
|
+
static ConfigurationSchema() {
|
|
1929
|
+
return Joi.object({
|
|
1930
|
+
sleep_time: Joi.number(),
|
|
1931
|
+
start_on_launch: Joi.boolean(),
|
|
1932
|
+
duration: Joi.number(),
|
|
1933
|
+
slide_direction: Joi.string().allow(""),
|
|
1934
|
+
});
|
|
1935
|
+
}
|
|
1936
|
+
|
|
1937
|
+
/** @returns {SlideshowMedia} */
|
|
1938
|
+
static SlideshowMedia() {
|
|
1939
|
+
return Joi.object({
|
|
1940
|
+
type: Joi.string().allow(""),
|
|
1941
|
+
url: Joi.string().allow(""),
|
|
1942
|
+
bg_color: Joi.string().allow(""),
|
|
1943
|
+
duration: Joi.number(),
|
|
1944
|
+
auto_decide_duration: Joi.boolean(),
|
|
1945
|
+
action: ContentPlatformModel.Action(),
|
|
1946
|
+
});
|
|
1947
|
+
}
|
|
1948
|
+
|
|
1880
1949
|
/** @returns {UpdateHandpickedSchema} */
|
|
1881
1950
|
static UpdateHandpickedSchema() {
|
|
1882
1951
|
return Joi.object({
|
|
@@ -2309,6 +2378,41 @@ class ContentPlatformModel {
|
|
|
2309
2378
|
});
|
|
2310
2379
|
}
|
|
2311
2380
|
|
|
2381
|
+
/** @returns {SlideshowGetDetails} */
|
|
2382
|
+
static SlideshowGetDetails() {
|
|
2383
|
+
return Joi.object({
|
|
2384
|
+
items: Joi.array().items(ContentPlatformModel.SlideshowSchema()),
|
|
2385
|
+
page: ContentPlatformModel.Page(),
|
|
2386
|
+
});
|
|
2387
|
+
}
|
|
2388
|
+
|
|
2389
|
+
/** @returns {SlideshowSchema} */
|
|
2390
|
+
static SlideshowSchema() {
|
|
2391
|
+
return Joi.object({
|
|
2392
|
+
_id: Joi.string().allow(""),
|
|
2393
|
+
slug: Joi.string().allow(""),
|
|
2394
|
+
date_meta: ContentPlatformModel.DateMeta(),
|
|
2395
|
+
application: Joi.string().allow(""),
|
|
2396
|
+
platform: Joi.string().allow(""),
|
|
2397
|
+
configuration: ContentPlatformModel.ConfigurationSchema(),
|
|
2398
|
+
media: Joi.array().items(ContentPlatformModel.SlideshowMedia()),
|
|
2399
|
+
active: Joi.boolean(),
|
|
2400
|
+
archived: Joi.boolean(),
|
|
2401
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
2402
|
+
});
|
|
2403
|
+
}
|
|
2404
|
+
|
|
2405
|
+
/** @returns {SlideshowPayload} */
|
|
2406
|
+
static SlideshowPayload() {
|
|
2407
|
+
return Joi.object({
|
|
2408
|
+
slug: Joi.string().allow(""),
|
|
2409
|
+
platform: Joi.string().allow(""),
|
|
2410
|
+
configuration: ContentPlatformModel.ConfigurationSchema(),
|
|
2411
|
+
media: ContentPlatformModel.SlideshowMedia(),
|
|
2412
|
+
active: Joi.boolean(),
|
|
2413
|
+
});
|
|
2414
|
+
}
|
|
2415
|
+
|
|
2312
2416
|
/** @returns {Support} */
|
|
2313
2417
|
static Support() {
|
|
2314
2418
|
return Joi.object({
|
|
@@ -345,7 +345,7 @@ declare class Order {
|
|
|
345
345
|
* @summary: List orders
|
|
346
346
|
* @description: Get a list of orders based on the filters provided. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getOrders/).
|
|
347
347
|
*/
|
|
348
|
-
getOrders({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, orderType, allowInactive, groupEntity, enforceDateFilter,
|
|
348
|
+
getOrders({ lane, searchType, bagStatus, timeToDispatch, paymentMethods, tags, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, isPrioritySort, customMeta, myOrders, showCrossCompanyData, customerId, orderType, allowInactive, groupEntity, enforceDateFilter, requestHeaders, }?: OrderPlatformValidator.GetOrdersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.OrderListingResponseSchema>;
|
|
349
349
|
/**
|
|
350
350
|
* @param {OrderPlatformValidator.GetRoleBasedActionsParam} arg - Arg object
|
|
351
351
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -401,7 +401,7 @@ declare class Order {
|
|
|
401
401
|
* @summary: List shipments
|
|
402
402
|
* @description: Get a list of shipments based on the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipments/).
|
|
403
403
|
*/
|
|
404
|
-
getShipments({ lane, bagStatus, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, fetchActiveShipment, allowInactive, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType, groupEntity, enforceDateFilter,
|
|
404
|
+
getShipments({ lane, bagStatus, statusOverrideLane, timeToDispatch, searchType, searchValue, fromDate, toDate, startDate, endDate, dpIds, stores, salesChannels, pageNo, pageSize, fetchActiveShipment, allowInactive, excludeLockedShipments, paymentMethods, channelShipmentId, channelOrderId, customMeta, orderingChannel, companyAffiliateTag, myOrders, platformUserId, sortType, showCrossCompanyData, tags, customerId, orderType, groupEntity, enforceDateFilter, requestHeaders, }?: OrderPlatformValidator.GetShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponseSchema>;
|
|
405
405
|
/**
|
|
406
406
|
* @param {OrderPlatformValidator.GetStateManagerConfigParam} arg - Arg object
|
|
407
407
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -2837,7 +2837,6 @@ class Order {
|
|
|
2837
2837
|
allowInactive,
|
|
2838
2838
|
groupEntity,
|
|
2839
2839
|
enforceDateFilter,
|
|
2840
|
-
fulfillmentType,
|
|
2841
2840
|
requestHeaders,
|
|
2842
2841
|
} = { requestHeaders: {} },
|
|
2843
2842
|
{ responseHeaders } = { responseHeaders: false }
|
|
@@ -2869,7 +2868,6 @@ class Order {
|
|
|
2869
2868
|
allowInactive,
|
|
2870
2869
|
groupEntity,
|
|
2871
2870
|
enforceDateFilter,
|
|
2872
|
-
fulfillmentType,
|
|
2873
2871
|
},
|
|
2874
2872
|
{ abortEarly: false, allowUnknown: true }
|
|
2875
2873
|
);
|
|
@@ -2905,7 +2903,6 @@ class Order {
|
|
|
2905
2903
|
allowInactive,
|
|
2906
2904
|
groupEntity,
|
|
2907
2905
|
enforceDateFilter,
|
|
2908
|
-
fulfillmentType,
|
|
2909
2906
|
},
|
|
2910
2907
|
{ abortEarly: false, allowUnknown: false }
|
|
2911
2908
|
);
|
|
@@ -2942,7 +2939,6 @@ class Order {
|
|
|
2942
2939
|
query_params["allow_inactive"] = allowInactive;
|
|
2943
2940
|
query_params["group_entity"] = groupEntity;
|
|
2944
2941
|
query_params["enforce_date_filter"] = enforceDateFilter;
|
|
2945
|
-
query_params["fulfillment_type"] = fulfillmentType;
|
|
2946
2942
|
|
|
2947
2943
|
const xHeaders = {};
|
|
2948
2944
|
|
|
@@ -3368,7 +3364,6 @@ class Order {
|
|
|
3368
3364
|
orderType,
|
|
3369
3365
|
groupEntity,
|
|
3370
3366
|
enforceDateFilter,
|
|
3371
|
-
fulfillmentType,
|
|
3372
3367
|
requestHeaders,
|
|
3373
3368
|
} = { requestHeaders: {} },
|
|
3374
3369
|
{ responseHeaders } = { responseHeaders: false }
|
|
@@ -3408,7 +3403,6 @@ class Order {
|
|
|
3408
3403
|
orderType,
|
|
3409
3404
|
groupEntity,
|
|
3410
3405
|
enforceDateFilter,
|
|
3411
|
-
fulfillmentType,
|
|
3412
3406
|
},
|
|
3413
3407
|
{ abortEarly: false, allowUnknown: true }
|
|
3414
3408
|
);
|
|
@@ -3452,7 +3446,6 @@ class Order {
|
|
|
3452
3446
|
orderType,
|
|
3453
3447
|
groupEntity,
|
|
3454
3448
|
enforceDateFilter,
|
|
3455
|
-
fulfillmentType,
|
|
3456
3449
|
},
|
|
3457
3450
|
{ abortEarly: false, allowUnknown: false }
|
|
3458
3451
|
);
|
|
@@ -3497,7 +3490,6 @@ class Order {
|
|
|
3497
3490
|
query_params["order_type"] = orderType;
|
|
3498
3491
|
query_params["group_entity"] = groupEntity;
|
|
3499
3492
|
query_params["enforce_date_filter"] = enforceDateFilter;
|
|
3500
|
-
query_params["fulfillment_type"] = fulfillmentType;
|
|
3501
3493
|
|
|
3502
3494
|
const xHeaders = {};
|
|
3503
3495
|
|
|
@@ -1507,27 +1507,6 @@ export = OrderPlatformModel;
|
|
|
1507
1507
|
* information about the API response.
|
|
1508
1508
|
* @property {VerifyOtpResponseData} [data]
|
|
1509
1509
|
*/
|
|
1510
|
-
/**
|
|
1511
|
-
* @typedef BulkReportsFiltersSchema
|
|
1512
|
-
* @property {string} [bag_status] - Comma separated values of bag statuses(to
|
|
1513
|
-
* be deprecated).
|
|
1514
|
-
* @property {string} [operational_status] - Comma separated values of
|
|
1515
|
-
* shipment's operational statuses.
|
|
1516
|
-
* @property {string} [stores] - Comma separated values of store ids.
|
|
1517
|
-
* @property {string} [time_to_dispatch] - Specifies the type of shipments to
|
|
1518
|
-
* retrieve. Use "1" for non-breached shipments and "-1" for breached shipments.
|
|
1519
|
-
* @property {string} [payment_methods] - Filters shipments by payment method.
|
|
1520
|
-
* Use "PREPAID" for shipments paid in advance, and "COD" for cash-on-delivery
|
|
1521
|
-
* shipments.
|
|
1522
|
-
* @property {string} [dp_ids] - Comma separated values of delivery partners.
|
|
1523
|
-
* Either dp_id or slug(extension_id|scheme_id).
|
|
1524
|
-
* @property {string} [sales_channels] - Comma separated values of sales channels ids.
|
|
1525
|
-
* @property {string} [tags] - A comma-separated list of tags associated with
|
|
1526
|
-
* the entity. Each tag is a keyword or label that categorizes or describes the entity.
|
|
1527
|
-
* @property {string} [lock_status] - Indicates the lock status of the entity.
|
|
1528
|
-
* "true" means the shipment is in a complete or partial lock state, while
|
|
1529
|
-
* "false" means it is unlocked.
|
|
1530
|
-
*/
|
|
1531
1510
|
/**
|
|
1532
1511
|
* @typedef BulkReportsDownloadRequestSchema
|
|
1533
1512
|
* @property {string[]} [store_ids] - A list of specific store IDs for which the
|
|
@@ -1549,7 +1528,6 @@ export = OrderPlatformModel;
|
|
|
1549
1528
|
* should include data from cross-company operations.
|
|
1550
1529
|
* @property {Object} [custom_filters_for_lane] - A flexible object that allows
|
|
1551
1530
|
* users to define custom filters specific to the lanes being reported on.
|
|
1552
|
-
* @property {BulkReportsFiltersSchema} [filters]
|
|
1553
1531
|
*/
|
|
1554
1532
|
/**
|
|
1555
1533
|
* @typedef BulkReportsDownloadResponseSchema
|
|
@@ -3065,7 +3043,7 @@ export = OrderPlatformModel;
|
|
|
3065
3043
|
*/
|
|
3066
3044
|
/**
|
|
3067
3045
|
* @typedef Article
|
|
3068
|
-
* @property {Object
|
|
3046
|
+
* @property {Object} [child_details] - Contains a flexible set of key-value
|
|
3069
3047
|
* pairs representing detailed information about the article's child entities,
|
|
3070
3048
|
* including dimensions (width, height, length), weight, and unique
|
|
3071
3049
|
* identifiers (EAN, article code, seller identifier) for each child entity.
|
|
@@ -4914,7 +4892,7 @@ export = OrderPlatformModel;
|
|
|
4914
4892
|
declare class OrderPlatformModel {
|
|
4915
4893
|
}
|
|
4916
4894
|
declare namespace OrderPlatformModel {
|
|
4917
|
-
export { InvalidateShipmentCachePayload, InvalidateShipmentCacheNestedResponseSchema, InvalidateShipmentCacheResponseSchema, UpdatePackingErrorResponseSchema, ErrorResponseSchema, StoreReassign, StoreReassignResponseSchema, LockManagerEntities, UpdateShipmentLockPayload, OriginalFilter, Bags, CheckResponseSchema, UpdateShipmentLockResponseSchema, AnnouncementResponseSchema, AnnouncementsResponseSchema, BaseResponseSchema, ErrorDetail, ProductsReasonsFilters, ProductsReasonsData, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, OrderItemDataUpdates, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, OrderDataUpdates, DataUpdates, ShipmentsRequestSchema, UpdatedAddressSchema, UpdateAddressRequestBody, StatuesRequestSchema, UpdateShipmentStatusRequestSchema, ShipmentsResponseSchema, DPConfiguration, PaymentConfig, LockStateMessage, CreateOrderConfig, StatuesResponseSchema, UpdateShipmentStatusResponseBody, OrderUser, OrderPriority, ArticleDetails, LocationDetails, ShipmentDetails, ShipmentConfig, ShipmentData, MarketPlacePdf, AffiliateBag, UserData, OrderInfo, AffiliateAppConfigMeta, AffiliateAppConfig, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateInventoryOrderConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryConfig, AffiliateConfig, Affiliate, AffiliateStoreIdMapping, OrderConfig, CreateOrderResponseSchema, DispatchManifest, SuccessResponseSchema, ActionInfo, GetActionsResponseSchema, HistoryReason, RefundInformation, HistoryMeta, HistoryDict, ShipmentHistoryResponseSchema, PostHistoryFilters, PostHistoryData, PostHistoryDict, PostShipmentHistory, SmsDataPayload, SendSmsPayload, OrderDetails, Meta, ShipmentDetail, OrderStatusData, OrderStatusResult, SendSmsResponseSchema, Dimension, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponseSchema, Tax, AmountSchema, Charge, LineItem, ProcessingDates, Tag, ProcessAfterConfig, SystemMessages, Shipment, GeoLocationSchema, ShippingInfo, BillingInfo, UserInfo, TaxInfo, PaymentMethod, PaymentInfo, CreateOrderAPI, CreateOrderErrorReponse, PaymentMethods, CreateChannelPaymentInfo, CreateChannelConfig, CreateChannelConfigData, CreateChannelConifgErrorResponseSchema, UploadManifestConsent, CreateChannelConfigResponseSchema, PlatformOrderUpdate, ResponseDetail, FyndOrderIdList, OrderStatus, BagStateTransitionMap, RoleBaseStateTransitionMapping, FetchCreditBalanceRequestPayload, CreditBalanceInfo, FetchCreditBalanceResponsePayload, RefundModeConfigRequestPayload, RefundOption, RefundModeFormat, RefundModeInfo, RefundModeConfigResponsePayload, AttachUserOtpData, AttachUserInfo, AttachOrderUser, AttachOrderUserResponseSchema, SendUserMobileOTP, PointBlankOtpData, SendUserMobileOtpResponseSchema, VerifyOtpData, VerifyMobileOTP, VerifyOtpResponseData, VerifyOtpResponseSchema,
|
|
4895
|
+
export { InvalidateShipmentCachePayload, InvalidateShipmentCacheNestedResponseSchema, InvalidateShipmentCacheResponseSchema, UpdatePackingErrorResponseSchema, ErrorResponseSchema, StoreReassign, StoreReassignResponseSchema, LockManagerEntities, UpdateShipmentLockPayload, OriginalFilter, Bags, CheckResponseSchema, UpdateShipmentLockResponseSchema, AnnouncementResponseSchema, AnnouncementsResponseSchema, BaseResponseSchema, ErrorDetail, ProductsReasonsFilters, ProductsReasonsData, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, OrderItemDataUpdates, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, OrderDataUpdates, DataUpdates, ShipmentsRequestSchema, UpdatedAddressSchema, UpdateAddressRequestBody, StatuesRequestSchema, UpdateShipmentStatusRequestSchema, ShipmentsResponseSchema, DPConfiguration, PaymentConfig, LockStateMessage, CreateOrderConfig, StatuesResponseSchema, UpdateShipmentStatusResponseBody, OrderUser, OrderPriority, ArticleDetails, LocationDetails, ShipmentDetails, ShipmentConfig, ShipmentData, MarketPlacePdf, AffiliateBag, UserData, OrderInfo, AffiliateAppConfigMeta, AffiliateAppConfig, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateInventoryOrderConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryConfig, AffiliateConfig, Affiliate, AffiliateStoreIdMapping, OrderConfig, CreateOrderResponseSchema, DispatchManifest, SuccessResponseSchema, ActionInfo, GetActionsResponseSchema, HistoryReason, RefundInformation, HistoryMeta, HistoryDict, ShipmentHistoryResponseSchema, PostHistoryFilters, PostHistoryData, PostHistoryDict, PostShipmentHistory, SmsDataPayload, SendSmsPayload, OrderDetails, Meta, ShipmentDetail, OrderStatusData, OrderStatusResult, SendSmsResponseSchema, Dimension, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponseSchema, Tax, AmountSchema, Charge, LineItem, ProcessingDates, Tag, ProcessAfterConfig, SystemMessages, Shipment, GeoLocationSchema, ShippingInfo, BillingInfo, UserInfo, TaxInfo, PaymentMethod, PaymentInfo, CreateOrderAPI, CreateOrderErrorReponse, PaymentMethods, CreateChannelPaymentInfo, CreateChannelConfig, CreateChannelConfigData, CreateChannelConifgErrorResponseSchema, UploadManifestConsent, CreateChannelConfigResponseSchema, PlatformOrderUpdate, ResponseDetail, FyndOrderIdList, OrderStatus, BagStateTransitionMap, RoleBaseStateTransitionMapping, FetchCreditBalanceRequestPayload, CreditBalanceInfo, FetchCreditBalanceResponsePayload, RefundModeConfigRequestPayload, RefundOption, RefundModeFormat, RefundModeInfo, RefundModeConfigResponsePayload, AttachUserOtpData, AttachUserInfo, AttachOrderUser, AttachOrderUserResponseSchema, SendUserMobileOTP, PointBlankOtpData, SendUserMobileOtpResponseSchema, VerifyOtpData, VerifyMobileOTP, VerifyOtpResponseData, VerifyOtpResponseSchema, BulkReportsDownloadRequestSchema, BulkReportsDownloadResponseSchema, APIFailedResponseSchema, BulkStateTransistionRequestSchema, BulkStateTransistionResponseSchema, ShipmentActionInfo, BulkActionListingData, BulkListinPage, BulkListingResponseSchema, JobDetailsData, JobDetailsResponseSchema, JobFailedResponseSchema, ManifestPageInfo, ManifestItemDetails, ManifestShipmentListing, DateRange, Filters, ManifestFile, ManifestMediaUpdate, PDFMeta, TotalShipmentPricesCount, ManifestMeta, Manifest, ManifestList, ManifestDetails, FiltersRequestSchema, ProcessManifest, ProcessManifestResponseSchema, ProcessManifestItemResponseSchema, FilterInfoOption, FiltersInfo, ManifestFiltersResponseSchema, PageDetails, EInvoiceIrnDetails, EInvoiceErrorDetails, EInvoiceDetails, EInvoiceResponseData, EInvoiceRetry, EInvoiceRetryResponseSchema, EInvoiceErrorInfo, EInvoiceErrorResponseData, EInvoiceErrorResponseSchema, EInvoiceErrorResponseDetails, EInvoiceRetryShipmentData, CourierPartnerTrackingDetails, CourierPartnerTrackingResponseSchema, LogsChannelDetails, LogPaymentDetails, FailedOrdersItem, FailedOrderLogs, FailedOrderLogDetails, GenerateInvoiceIDResponseData, GenerateInvoiceIDErrorResponseData, GenerateInvoiceIDRequestSchema, GenerateInvoiceIDResponseSchema, GenerateInvoiceIDErrorResponseSchema, ManifestResponseSchema, ProcessManifestRequestSchema, ManifestItems, ManifestErrorResponseSchema, ConfigData, ConfigUpdatedResponseSchema, FlagData, Flags, Filter, PostHook, PreHook, Config, TransitionConfigCondition, TransitionConfigData, TransitionConfigPayload, RuleListRequestSchema, RuleErrorResponseSchema, RMAPageInfo, RuleAction, QuestionSetItem, Reason, Conditions, RuleItem, RuleError, RuleListResponseSchema, UpdateShipmentPaymentMode, CommonErrorResponseSchema, ExceptionErrorResponseSchema, ProductSchema, PaymentMethodSchema, ActionDetailSchema, PaymentMetaDataSchema, PaymentMetaLogoURLSchema, ValidationError, Page, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentStatus, UserDataInfo, Address, ShipmentListingChannel, Prices, ChargeDistributionSchema, ChargeDistributionLogic, ChargeAmountCurrency, ChargeAmount, PriceAdjustmentCharge, OrderingCurrencyPrices, Identifier, FinancialBreakup, GSTDetailsData, BagStateMapper, BagStatusHistory, Dimensions, ReturnConfig, Weight, Article, ShipmentListingBrand, ReplacementDetails, AffiliateMeta, AffiliateBagDetails, PlatformArticleAttributes, PlatformItem, Dates, BagReturnableCancelableStatus, BagUnit, ShipmentItemFulFillingStore, Currency, OrderingCurrency, ConversionRate, CurrencyInfo, ShipmentItem, ShipmentInternalPlatformViewResponseSchema, TrackingList, InvoiceInfo, OrderDetailsData, UserDetailsData, PhoneDetails, ContactDetails, CompanyDetails, OrderingStoreDetails, DPDetailsData, BuyerDetails, DebugInfo, EinvoiceInfo, Formatted, ShipmentTags, LockData, ShipmentTimeStamp, ShipmentMeta, PDFLinks, AffiliateDetails, BagConfigs, OrderBagArticle, OrderBrandName, AffiliateBagsDetails, BagPaymentMethods, DiscountRules, ItemCriterias, BuyRules, PriceMinMax, ItemPriceDetails, FreeGiftItems, AppliedFreeArticles, AppliedPromos, CurrentStatus, OrderBags, FulfillingStore, ShipmentPayments, ShipmentStatusData, ShipmentLockDetails, PlatformShipment, ShipmentInfoResponseSchema, TaxDetails, PaymentInfoData, CurrencySchema, OrderData, OrderDetailsResponseSchema, SubLane, SuperLane, LaneConfigResponseSchema, PlatformBreakupValues, PlatformChannel, PlatformOrderItems, OrderListingResponseSchema, PlatformTrack, PlatformShipmentTrack, AdvanceFilterInfo, FiltersResponseSchema, URL, FileResponseSchema, BulkActionTemplate, BulkActionTemplateResponseSchema, PlatformShipmentReasonsResponseSchema, ShipmentResponseReasons, ShipmentReasonsResponseSchema, StoreAddress, EInvoicePortalDetails, StoreEinvoice, StoreEwaybill, StoreGstCredentials, Document, StoreDocuments, StoreMeta, Store, Brand, Item, ArticleStatusDetails, Company, ShipmentGstDetails, DeliverySlotDetails, InvoiceDetails, UserDetails, WeightData, BagDetails, BagDetailsPlatformResponseSchema, BagsPage, BagData, GetBagsPlatformResponseSchema, GeneratePosOrderReceiptResponseSchema, Templates, AllowedTemplatesResponseSchema, TemplateDownloadResponseSchema, Error, BulkFailedResponseSchema };
|
|
4918
4896
|
}
|
|
4919
4897
|
/** @returns {InvalidateShipmentCachePayload} */
|
|
4920
4898
|
declare function InvalidateShipmentCachePayload(): InvalidateShipmentCachePayload;
|
|
@@ -7886,55 +7864,6 @@ type VerifyOtpResponseSchema = {
|
|
|
7886
7864
|
message?: string;
|
|
7887
7865
|
data?: VerifyOtpResponseData;
|
|
7888
7866
|
};
|
|
7889
|
-
/** @returns {BulkReportsFiltersSchema} */
|
|
7890
|
-
declare function BulkReportsFiltersSchema(): BulkReportsFiltersSchema;
|
|
7891
|
-
type BulkReportsFiltersSchema = {
|
|
7892
|
-
/**
|
|
7893
|
-
* - Comma separated values of bag statuses(to
|
|
7894
|
-
* be deprecated).
|
|
7895
|
-
*/
|
|
7896
|
-
bag_status?: string;
|
|
7897
|
-
/**
|
|
7898
|
-
* - Comma separated values of
|
|
7899
|
-
* shipment's operational statuses.
|
|
7900
|
-
*/
|
|
7901
|
-
operational_status?: string;
|
|
7902
|
-
/**
|
|
7903
|
-
* - Comma separated values of store ids.
|
|
7904
|
-
*/
|
|
7905
|
-
stores?: string;
|
|
7906
|
-
/**
|
|
7907
|
-
* - Specifies the type of shipments to
|
|
7908
|
-
* retrieve. Use "1" for non-breached shipments and "-1" for breached shipments.
|
|
7909
|
-
*/
|
|
7910
|
-
time_to_dispatch?: string;
|
|
7911
|
-
/**
|
|
7912
|
-
* - Filters shipments by payment method.
|
|
7913
|
-
* Use "PREPAID" for shipments paid in advance, and "COD" for cash-on-delivery
|
|
7914
|
-
* shipments.
|
|
7915
|
-
*/
|
|
7916
|
-
payment_methods?: string;
|
|
7917
|
-
/**
|
|
7918
|
-
* - Comma separated values of delivery partners.
|
|
7919
|
-
* Either dp_id or slug(extension_id|scheme_id).
|
|
7920
|
-
*/
|
|
7921
|
-
dp_ids?: string;
|
|
7922
|
-
/**
|
|
7923
|
-
* - Comma separated values of sales channels ids.
|
|
7924
|
-
*/
|
|
7925
|
-
sales_channels?: string;
|
|
7926
|
-
/**
|
|
7927
|
-
* - A comma-separated list of tags associated with
|
|
7928
|
-
* the entity. Each tag is a keyword or label that categorizes or describes the entity.
|
|
7929
|
-
*/
|
|
7930
|
-
tags?: string;
|
|
7931
|
-
/**
|
|
7932
|
-
* - Indicates the lock status of the entity.
|
|
7933
|
-
* "true" means the shipment is in a complete or partial lock state, while
|
|
7934
|
-
* "false" means it is unlocked.
|
|
7935
|
-
*/
|
|
7936
|
-
lock_status?: string;
|
|
7937
|
-
};
|
|
7938
7867
|
/** @returns {BulkReportsDownloadRequestSchema} */
|
|
7939
7868
|
declare function BulkReportsDownloadRequestSchema(): BulkReportsDownloadRequestSchema;
|
|
7940
7869
|
type BulkReportsDownloadRequestSchema = {
|
|
@@ -7987,7 +7916,6 @@ type BulkReportsDownloadRequestSchema = {
|
|
|
7987
7916
|
* users to define custom filters specific to the lanes being reported on.
|
|
7988
7917
|
*/
|
|
7989
7918
|
custom_filters_for_lane?: any;
|
|
7990
|
-
filters?: BulkReportsFiltersSchema;
|
|
7991
7919
|
};
|
|
7992
7920
|
/** @returns {BulkReportsDownloadResponseSchema} */
|
|
7993
7921
|
declare function BulkReportsDownloadResponseSchema(): BulkReportsDownloadResponseSchema;
|
|
@@ -11191,7 +11119,7 @@ type Article = {
|
|
|
11191
11119
|
* including dimensions (width, height, length), weight, and unique
|
|
11192
11120
|
* identifiers (EAN, article code, seller identifier) for each child entity.
|
|
11193
11121
|
*/
|
|
11194
|
-
child_details?: any
|
|
11122
|
+
child_details?: any;
|
|
11195
11123
|
/**
|
|
11196
11124
|
* - Unique identifier assigned by the
|
|
11197
11125
|
* seller to the article, used for inventory management.
|