@gofynd/fdk-client-javascript 1.4.0-beta.1 → 1.4.0-beta.3
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/CartApplicationModel.d.ts +2 -0
- package/sdk/application/Cart/CartApplicationModel.js +2 -0
- package/sdk/application/Order/OrderApplicationModel.d.ts +2 -0
- package/sdk/application/Order/OrderApplicationModel.js +2 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +240 -315
- package/sdk/partner/Theme/ThemePartnerModel.js +332 -222
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +4 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +4 -1
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +2 -12
- package/sdk/platform/Catalog/CatalogPlatformClient.js +17 -87
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +11 -25
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +4 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +8 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +2 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +4 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +4 -1
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -0
- package/sdk/platform/Discount/DiscountPlatformModel.js +2 -0
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -1
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +116 -44
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +120 -54
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +4 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +0 -12
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +4 -86
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -12
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -14
- package/sdk/platform/Order/OrderPlatformClient.d.ts +11 -61
- package/sdk/platform/Order/OrderPlatformClient.js +87 -481
- package/sdk/platform/Order/OrderPlatformModel.d.ts +442 -171
- package/sdk/platform/Order/OrderPlatformModel.js +483 -169
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +22 -69
- package/sdk/platform/Order/OrderPlatformValidator.js +17 -79
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +4 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +4 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +4 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.js +4 -1
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +4 -1
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +103 -21
- package/sdk/platform/Theme/ThemePlatformModel.js +108 -20
- package/sdk/platform/User/UserPlatformApplicationClient.js +4 -1
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +2 -2
- package/sdk/platform/Webhook/WebhookPlatformClient.js +4 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +21 -27
- package/sdk/platform/Webhook/WebhookPlatformModel.js +30 -27
|
@@ -66,6 +66,11 @@ export = OrderPlatformValidator;
|
|
|
66
66
|
* @typedef FetchRefundModeConfigParam
|
|
67
67
|
* @property {OrderPlatformModel.RefundModeConfigRequestPayload} body
|
|
68
68
|
*/
|
|
69
|
+
/**
|
|
70
|
+
* @typedef GenerateInvoiceIDParam
|
|
71
|
+
* @property {string} invoiceType - Mention the type of invoice id to generate
|
|
72
|
+
* @property {OrderPlatformModel.GenerateInvoiceIDRequest} body
|
|
73
|
+
*/
|
|
69
74
|
/**
|
|
70
75
|
* @typedef GeneratePOSReceiptByOrderIdParam
|
|
71
76
|
* @property {string} orderId
|
|
@@ -224,6 +229,8 @@ export = OrderPlatformValidator;
|
|
|
224
229
|
* @typedef GetShipmentByIdParam
|
|
225
230
|
* @property {string} [channelShipmentId] - App Shipment Id
|
|
226
231
|
* @property {string} [shipmentId] - Shipment Id
|
|
232
|
+
* @property {boolean} [fetchActiveShipment] - Flag to fetch active or
|
|
233
|
+
* deactivated shipments
|
|
227
234
|
*/
|
|
228
235
|
/**
|
|
229
236
|
* @typedef GetShipmentHistoryParam
|
|
@@ -275,34 +282,6 @@ export = OrderPlatformValidator;
|
|
|
275
282
|
* @property {string} [customerId]
|
|
276
283
|
* @property {string} [orderType]
|
|
277
284
|
*/
|
|
278
|
-
/**
|
|
279
|
-
* @typedef GetStateManagerTaskByIdParam
|
|
280
|
-
* @property {number} taskId
|
|
281
|
-
*/
|
|
282
|
-
/**
|
|
283
|
-
* @typedef GetStateManagerTasksParam
|
|
284
|
-
* @property {number} [pageNo]
|
|
285
|
-
* @property {number} [pageSize]
|
|
286
|
-
*/
|
|
287
|
-
/**
|
|
288
|
-
* @typedef GetStateTransitionFiltersParam
|
|
289
|
-
* @property {number} [pageNo]
|
|
290
|
-
* @property {number} [pageSize]
|
|
291
|
-
*/
|
|
292
|
-
/**
|
|
293
|
-
* @typedef GetStateTransitionFiltersByIdParam
|
|
294
|
-
* @property {number} filterId
|
|
295
|
-
*/
|
|
296
|
-
/**
|
|
297
|
-
* @typedef GetStateTransitionFlagsParam
|
|
298
|
-
* @property {number} [pageNo] - The page number for pagination.
|
|
299
|
-
* @property {number} [pageSize] - The number of items to be returned per page
|
|
300
|
-
* for pagination.
|
|
301
|
-
*/
|
|
302
|
-
/**
|
|
303
|
-
* @typedef GetStateTransitionFlagsByIdParam
|
|
304
|
-
* @property {number} flagId
|
|
305
|
-
*/
|
|
306
285
|
/** @typedef GetStateTransitionMapParam */
|
|
307
286
|
/**
|
|
308
287
|
* @typedef GetTemplateParam
|
|
@@ -421,6 +400,8 @@ declare class OrderPlatformValidator {
|
|
|
421
400
|
static fetchCreditBalanceDetail(): FetchCreditBalanceDetailParam;
|
|
422
401
|
/** @returns {FetchRefundModeConfigParam} */
|
|
423
402
|
static fetchRefundModeConfig(): FetchRefundModeConfigParam;
|
|
403
|
+
/** @returns {GenerateInvoiceIDParam} */
|
|
404
|
+
static generateInvoiceID(): GenerateInvoiceIDParam;
|
|
424
405
|
/** @returns {GeneratePOSReceiptByOrderIdParam} */
|
|
425
406
|
static generatePOSReceiptByOrderId(): GeneratePOSReceiptByOrderIdParam;
|
|
426
407
|
/** @returns {GetAllowedStateTransitionParam} */
|
|
@@ -465,18 +446,6 @@ declare class OrderPlatformValidator {
|
|
|
465
446
|
static getShipmentReasons(): GetShipmentReasonsParam;
|
|
466
447
|
/** @returns {GetShipmentsParam} */
|
|
467
448
|
static getShipments(): GetShipmentsParam;
|
|
468
|
-
/** @returns {GetStateManagerTaskByIdParam} */
|
|
469
|
-
static getStateManagerTaskById(): GetStateManagerTaskByIdParam;
|
|
470
|
-
/** @returns {GetStateManagerTasksParam} */
|
|
471
|
-
static getStateManagerTasks(): GetStateManagerTasksParam;
|
|
472
|
-
/** @returns {GetStateTransitionFiltersParam} */
|
|
473
|
-
static getStateTransitionFilters(): GetStateTransitionFiltersParam;
|
|
474
|
-
/** @returns {GetStateTransitionFiltersByIdParam} */
|
|
475
|
-
static getStateTransitionFiltersById(): GetStateTransitionFiltersByIdParam;
|
|
476
|
-
/** @returns {GetStateTransitionFlagsParam} */
|
|
477
|
-
static getStateTransitionFlags(): GetStateTransitionFlagsParam;
|
|
478
|
-
/** @returns {GetStateTransitionFlagsByIdParam} */
|
|
479
|
-
static getStateTransitionFlagsById(): GetStateTransitionFlagsByIdParam;
|
|
480
449
|
/** @returns {GetStateTransitionMapParam} */
|
|
481
450
|
static getStateTransitionMap(): any;
|
|
482
451
|
/** @returns {GetTemplateParam} */
|
|
@@ -517,7 +486,7 @@ declare class OrderPlatformValidator {
|
|
|
517
486
|
static verifyMobileOTP(): VerifyMobileOTPParam;
|
|
518
487
|
}
|
|
519
488
|
declare namespace OrderPlatformValidator {
|
|
520
|
-
export { AttachOrderUserParam, BulkListingParam, BulkStateTransistionParam, CheckOrderStatusParam, Click2CallParam, CreateChannelConfigParam, CreateOrderParam, DispatchManifestsParam, DownloadBulkActionTemplateParam, DownloadLanesReportParam, EInvoiceRetryParam, FailedOrderLogDetailsParam, FetchCreditBalanceDetailParam, FetchRefundModeConfigParam, GeneratePOSReceiptByOrderIdParam, GetAllowedStateTransitionParam, GetAllowedTemplatesForBulkParam, GetAnnouncementsParam, GetBagByIdParam, GetBagsParam, GetBulkActionTemplateParam, GetBulkShipmentExcelFileParam, GetChannelConfigParam, GetFileByStatusParam, GetLaneConfigParam, GetManifestDetailsParam, GetManifestShipmentsParam, GetManifestfiltersParam, GetManifestsParam, GetOrderByIdParam, GetOrdersParam, GetRoleBasedActionsParam, GetShipmentByIdParam, GetShipmentHistoryParam, GetShipmentReasonsParam, GetShipmentsParam,
|
|
489
|
+
export { AttachOrderUserParam, BulkListingParam, BulkStateTransistionParam, CheckOrderStatusParam, Click2CallParam, CreateChannelConfigParam, CreateOrderParam, DispatchManifestsParam, DownloadBulkActionTemplateParam, DownloadLanesReportParam, EInvoiceRetryParam, FailedOrderLogDetailsParam, FetchCreditBalanceDetailParam, FetchRefundModeConfigParam, GenerateInvoiceIDParam, GeneratePOSReceiptByOrderIdParam, GetAllowedStateTransitionParam, GetAllowedTemplatesForBulkParam, GetAnnouncementsParam, GetBagByIdParam, GetBagsParam, GetBulkActionTemplateParam, GetBulkShipmentExcelFileParam, GetChannelConfigParam, GetFileByStatusParam, GetLaneConfigParam, GetManifestDetailsParam, GetManifestShipmentsParam, GetManifestfiltersParam, GetManifestsParam, GetOrderByIdParam, GetOrdersParam, GetRoleBasedActionsParam, GetShipmentByIdParam, GetShipmentHistoryParam, GetShipmentReasonsParam, GetShipmentsParam, GetStateTransitionMapParam, GetTemplateParam, GetfiltersParam, InvalidateShipmentCacheParam, JobDetailsParam, OrderUpdateParam, PostShipmentHistoryParam, ProcessManifestsParam, ReassignLocationParam, SendSmsNinjaParam, SendUserMobileOTPParam, TrackShipmentParam, UpdateAddressParam, UpdatePackagingDimensionsParam, UpdateShipmentLockParam, UpdateShipmentStatusParam, UpdateShipmentTrackingParam, UploadConsentsParam, VerifyMobileOTPParam };
|
|
521
490
|
}
|
|
522
491
|
type AttachOrderUserParam = {
|
|
523
492
|
body: OrderPlatformModel.AttachOrderUser;
|
|
@@ -614,6 +583,13 @@ type FetchCreditBalanceDetailParam = {
|
|
|
614
583
|
type FetchRefundModeConfigParam = {
|
|
615
584
|
body: OrderPlatformModel.RefundModeConfigRequestPayload;
|
|
616
585
|
};
|
|
586
|
+
type GenerateInvoiceIDParam = {
|
|
587
|
+
/**
|
|
588
|
+
* - Mention the type of invoice id to generate
|
|
589
|
+
*/
|
|
590
|
+
invoiceType: string;
|
|
591
|
+
body: OrderPlatformModel.GenerateInvoiceIDRequest;
|
|
592
|
+
};
|
|
617
593
|
type GeneratePOSReceiptByOrderIdParam = {
|
|
618
594
|
orderId: string;
|
|
619
595
|
shipmentId?: string;
|
|
@@ -918,6 +894,11 @@ type GetShipmentByIdParam = {
|
|
|
918
894
|
* - Shipment Id
|
|
919
895
|
*/
|
|
920
896
|
shipmentId?: string;
|
|
897
|
+
/**
|
|
898
|
+
* - Flag to fetch active or
|
|
899
|
+
* deactivated shipments
|
|
900
|
+
*/
|
|
901
|
+
fetchActiveShipment?: boolean;
|
|
921
902
|
};
|
|
922
903
|
type GetShipmentHistoryParam = {
|
|
923
904
|
/**
|
|
@@ -1050,34 +1031,6 @@ type GetShipmentsParam = {
|
|
|
1050
1031
|
customerId?: string;
|
|
1051
1032
|
orderType?: string;
|
|
1052
1033
|
};
|
|
1053
|
-
type GetStateManagerTaskByIdParam = {
|
|
1054
|
-
taskId: number;
|
|
1055
|
-
};
|
|
1056
|
-
type GetStateManagerTasksParam = {
|
|
1057
|
-
pageNo?: number;
|
|
1058
|
-
pageSize?: number;
|
|
1059
|
-
};
|
|
1060
|
-
type GetStateTransitionFiltersParam = {
|
|
1061
|
-
pageNo?: number;
|
|
1062
|
-
pageSize?: number;
|
|
1063
|
-
};
|
|
1064
|
-
type GetStateTransitionFiltersByIdParam = {
|
|
1065
|
-
filterId: number;
|
|
1066
|
-
};
|
|
1067
|
-
type GetStateTransitionFlagsParam = {
|
|
1068
|
-
/**
|
|
1069
|
-
* - The page number for pagination.
|
|
1070
|
-
*/
|
|
1071
|
-
pageNo?: number;
|
|
1072
|
-
/**
|
|
1073
|
-
* - The number of items to be returned per page
|
|
1074
|
-
* for pagination.
|
|
1075
|
-
*/
|
|
1076
|
-
pageSize?: number;
|
|
1077
|
-
};
|
|
1078
|
-
type GetStateTransitionFlagsByIdParam = {
|
|
1079
|
-
flagId: number;
|
|
1080
|
-
};
|
|
1081
1034
|
type GetTemplateParam = {
|
|
1082
1035
|
templateName: string;
|
|
1083
1036
|
};
|
|
@@ -83,6 +83,12 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
83
83
|
* @property {OrderPlatformModel.RefundModeConfigRequestPayload} body
|
|
84
84
|
*/
|
|
85
85
|
|
|
86
|
+
/**
|
|
87
|
+
* @typedef GenerateInvoiceIDParam
|
|
88
|
+
* @property {string} invoiceType - Mention the type of invoice id to generate
|
|
89
|
+
* @property {OrderPlatformModel.GenerateInvoiceIDRequest} body
|
|
90
|
+
*/
|
|
91
|
+
|
|
86
92
|
/**
|
|
87
93
|
* @typedef GeneratePOSReceiptByOrderIdParam
|
|
88
94
|
* @property {string} orderId
|
|
@@ -259,6 +265,8 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
259
265
|
* @typedef GetShipmentByIdParam
|
|
260
266
|
* @property {string} [channelShipmentId] - App Shipment Id
|
|
261
267
|
* @property {string} [shipmentId] - Shipment Id
|
|
268
|
+
* @property {boolean} [fetchActiveShipment] - Flag to fetch active or
|
|
269
|
+
* deactivated shipments
|
|
262
270
|
*/
|
|
263
271
|
|
|
264
272
|
/**
|
|
@@ -314,40 +322,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
314
322
|
* @property {string} [orderType]
|
|
315
323
|
*/
|
|
316
324
|
|
|
317
|
-
/**
|
|
318
|
-
* @typedef GetStateManagerTaskByIdParam
|
|
319
|
-
* @property {number} taskId
|
|
320
|
-
*/
|
|
321
|
-
|
|
322
|
-
/**
|
|
323
|
-
* @typedef GetStateManagerTasksParam
|
|
324
|
-
* @property {number} [pageNo]
|
|
325
|
-
* @property {number} [pageSize]
|
|
326
|
-
*/
|
|
327
|
-
|
|
328
|
-
/**
|
|
329
|
-
* @typedef GetStateTransitionFiltersParam
|
|
330
|
-
* @property {number} [pageNo]
|
|
331
|
-
* @property {number} [pageSize]
|
|
332
|
-
*/
|
|
333
|
-
|
|
334
|
-
/**
|
|
335
|
-
* @typedef GetStateTransitionFiltersByIdParam
|
|
336
|
-
* @property {number} filterId
|
|
337
|
-
*/
|
|
338
|
-
|
|
339
|
-
/**
|
|
340
|
-
* @typedef GetStateTransitionFlagsParam
|
|
341
|
-
* @property {number} [pageNo] - The page number for pagination.
|
|
342
|
-
* @property {number} [pageSize] - The number of items to be returned per page
|
|
343
|
-
* for pagination.
|
|
344
|
-
*/
|
|
345
|
-
|
|
346
|
-
/**
|
|
347
|
-
* @typedef GetStateTransitionFlagsByIdParam
|
|
348
|
-
* @property {number} flagId
|
|
349
|
-
*/
|
|
350
|
-
|
|
351
325
|
/** @typedef GetStateTransitionMapParam */
|
|
352
326
|
|
|
353
327
|
/**
|
|
@@ -566,6 +540,14 @@ class OrderPlatformValidator {
|
|
|
566
540
|
}).required();
|
|
567
541
|
}
|
|
568
542
|
|
|
543
|
+
/** @returns {GenerateInvoiceIDParam} */
|
|
544
|
+
static generateInvoiceID() {
|
|
545
|
+
return Joi.object({
|
|
546
|
+
invoiceType: Joi.string().allow("").required(),
|
|
547
|
+
body: OrderPlatformModel.GenerateInvoiceIDRequest().required(),
|
|
548
|
+
}).required();
|
|
549
|
+
}
|
|
550
|
+
|
|
569
551
|
/** @returns {GeneratePOSReceiptByOrderIdParam} */
|
|
570
552
|
static generatePOSReceiptByOrderId() {
|
|
571
553
|
return Joi.object({
|
|
@@ -774,6 +756,7 @@ class OrderPlatformValidator {
|
|
|
774
756
|
return Joi.object({
|
|
775
757
|
channelShipmentId: Joi.string().allow(""),
|
|
776
758
|
shipmentId: Joi.string().allow(""),
|
|
759
|
+
fetchActiveShipment: Joi.boolean(),
|
|
777
760
|
}).required();
|
|
778
761
|
}
|
|
779
762
|
|
|
@@ -831,51 +814,6 @@ class OrderPlatformValidator {
|
|
|
831
814
|
}).required();
|
|
832
815
|
}
|
|
833
816
|
|
|
834
|
-
/** @returns {GetStateManagerTaskByIdParam} */
|
|
835
|
-
static getStateManagerTaskById() {
|
|
836
|
-
return Joi.object({
|
|
837
|
-
taskId: Joi.number().required(),
|
|
838
|
-
}).required();
|
|
839
|
-
}
|
|
840
|
-
|
|
841
|
-
/** @returns {GetStateManagerTasksParam} */
|
|
842
|
-
static getStateManagerTasks() {
|
|
843
|
-
return Joi.object({
|
|
844
|
-
pageNo: Joi.number(),
|
|
845
|
-
pageSize: Joi.number(),
|
|
846
|
-
}).required();
|
|
847
|
-
}
|
|
848
|
-
|
|
849
|
-
/** @returns {GetStateTransitionFiltersParam} */
|
|
850
|
-
static getStateTransitionFilters() {
|
|
851
|
-
return Joi.object({
|
|
852
|
-
pageNo: Joi.number(),
|
|
853
|
-
pageSize: Joi.number(),
|
|
854
|
-
}).required();
|
|
855
|
-
}
|
|
856
|
-
|
|
857
|
-
/** @returns {GetStateTransitionFiltersByIdParam} */
|
|
858
|
-
static getStateTransitionFiltersById() {
|
|
859
|
-
return Joi.object({
|
|
860
|
-
filterId: Joi.number().required(),
|
|
861
|
-
}).required();
|
|
862
|
-
}
|
|
863
|
-
|
|
864
|
-
/** @returns {GetStateTransitionFlagsParam} */
|
|
865
|
-
static getStateTransitionFlags() {
|
|
866
|
-
return Joi.object({
|
|
867
|
-
pageNo: Joi.number(),
|
|
868
|
-
pageSize: Joi.number(),
|
|
869
|
-
}).required();
|
|
870
|
-
}
|
|
871
|
-
|
|
872
|
-
/** @returns {GetStateTransitionFlagsByIdParam} */
|
|
873
|
-
static getStateTransitionFlagsById() {
|
|
874
|
-
return Joi.object({
|
|
875
|
-
flagId: Joi.number().required(),
|
|
876
|
-
}).required();
|
|
877
|
-
}
|
|
878
|
-
|
|
879
817
|
/** @returns {GetStateTransitionMapParam} */
|
|
880
818
|
static getStateTransitionMap() {
|
|
881
819
|
return Joi.object({}).required();
|
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
const PlatformAPIClient = require("../PlatformAPIClient");
|
|
2
|
-
const {
|
|
2
|
+
const {
|
|
3
|
+
FDKClientValidationError,
|
|
4
|
+
FDKResponseValidationError,
|
|
5
|
+
} = require("../../common/FDKError");
|
|
3
6
|
const Paginator = require("../../common/Paginator");
|
|
4
7
|
const PartnerPlatformApplicationValidator = require("./PartnerPlatformApplicationValidator");
|
|
5
8
|
const PartnerPlatformModel = require("./PartnerPlatformModel");
|
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
const PlatformAPIClient = require("../PlatformAPIClient");
|
|
2
|
-
const {
|
|
2
|
+
const {
|
|
3
|
+
FDKClientValidationError,
|
|
4
|
+
FDKResponseValidationError,
|
|
5
|
+
} = require("../../common/FDKError");
|
|
3
6
|
const Paginator = require("../../common/Paginator");
|
|
4
7
|
const PaymentPlatformApplicationValidator = require("./PaymentPlatformApplicationValidator");
|
|
5
8
|
const PaymentPlatformModel = require("./PaymentPlatformModel");
|
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
const PlatformAPIClient = require("../PlatformAPIClient");
|
|
2
|
-
const {
|
|
2
|
+
const {
|
|
3
|
+
FDKClientValidationError,
|
|
4
|
+
FDKResponseValidationError,
|
|
5
|
+
} = require("../../common/FDKError");
|
|
3
6
|
const Paginator = require("../../common/Paginator");
|
|
4
7
|
const RewardsPlatformApplicationValidator = require("./RewardsPlatformApplicationValidator");
|
|
5
8
|
const RewardsPlatformModel = require("./RewardsPlatformModel");
|
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
const PlatformAPIClient = require("../PlatformAPIClient");
|
|
2
|
-
const {
|
|
2
|
+
const {
|
|
3
|
+
FDKClientValidationError,
|
|
4
|
+
FDKResponseValidationError,
|
|
5
|
+
} = require("../../common/FDKError");
|
|
3
6
|
const Paginator = require("../../common/Paginator");
|
|
4
7
|
const ServiceabilityPlatformApplicationValidator = require("./ServiceabilityPlatformApplicationValidator");
|
|
5
8
|
const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
const PlatformAPIClient = require("../PlatformAPIClient");
|
|
2
|
-
const {
|
|
2
|
+
const {
|
|
3
|
+
FDKClientValidationError,
|
|
4
|
+
FDKResponseValidationError,
|
|
5
|
+
} = require("../../common/FDKError");
|
|
3
6
|
const Paginator = require("../../common/Paginator");
|
|
4
7
|
const SharePlatformApplicationValidator = require("./SharePlatformApplicationValidator");
|
|
5
8
|
const SharePlatformModel = require("./SharePlatformModel");
|
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
const PlatformAPIClient = require("../PlatformAPIClient");
|
|
2
|
-
const {
|
|
2
|
+
const {
|
|
3
|
+
FDKClientValidationError,
|
|
4
|
+
FDKResponseValidationError,
|
|
5
|
+
} = require("../../common/FDKError");
|
|
3
6
|
const Paginator = require("../../common/Paginator");
|
|
4
7
|
const ThemePlatformApplicationValidator = require("./ThemePlatformApplicationValidator");
|
|
5
8
|
const ThemePlatformModel = require("./ThemePlatformModel");
|
|
@@ -61,6 +61,7 @@ export = ThemePlatformModel;
|
|
|
61
61
|
/**
|
|
62
62
|
* @typedef AvailablePageSchema
|
|
63
63
|
* @property {string} [_id]
|
|
64
|
+
* @property {string} [created_at] - The creation timestamp of the page
|
|
64
65
|
* @property {string} [path]
|
|
65
66
|
* @property {Object[]} [props]
|
|
66
67
|
* @property {AvailablePageSchemaSections[]} [sections]
|
|
@@ -69,6 +70,7 @@ export = ThemePlatformModel;
|
|
|
69
70
|
* @property {string} [text]
|
|
70
71
|
* @property {string} [theme]
|
|
71
72
|
* @property {string} [type]
|
|
73
|
+
* @property {string} [updated_at] - The last update timestamp of the page
|
|
72
74
|
* @property {string} [value]
|
|
73
75
|
*/
|
|
74
76
|
/**
|
|
@@ -79,6 +81,7 @@ export = ThemePlatformModel;
|
|
|
79
81
|
* @property {AvailablePagePredicate} [predicate]
|
|
80
82
|
* @property {Object} [preset]
|
|
81
83
|
* @property {Object} [props]
|
|
84
|
+
* @property {string} [source]
|
|
82
85
|
*/
|
|
83
86
|
/**
|
|
84
87
|
* @typedef AvailablePageScreenPredicate
|
|
@@ -94,7 +97,6 @@ export = ThemePlatformModel;
|
|
|
94
97
|
* @typedef AvailablePageSeo
|
|
95
98
|
* @property {string} [_id]
|
|
96
99
|
* @property {SEObreadcrumb[]} [breadcrumb]
|
|
97
|
-
* @property {string} [canonical_url]
|
|
98
100
|
* @property {string} [description]
|
|
99
101
|
* @property {SEOMetaItem[]} [meta_tags]
|
|
100
102
|
* @property {SEOSitemap} [sitemap]
|
|
@@ -175,6 +177,7 @@ export = ThemePlatformModel;
|
|
|
175
177
|
*/
|
|
176
178
|
/**
|
|
177
179
|
* @typedef CSS
|
|
180
|
+
* @property {string} [link]
|
|
178
181
|
* @property {string[]} [links]
|
|
179
182
|
*/
|
|
180
183
|
/**
|
|
@@ -219,6 +222,11 @@ export = ThemePlatformModel;
|
|
|
219
222
|
* @property {string} [text_strikethrough_price_color] - The text strikethrough
|
|
220
223
|
* price color
|
|
221
224
|
*/
|
|
225
|
+
/**
|
|
226
|
+
* @typedef DividerStrokeHighlight
|
|
227
|
+
* @property {string} [divider_strokes]
|
|
228
|
+
* @property {string} [highlight]
|
|
229
|
+
*/
|
|
222
230
|
/**
|
|
223
231
|
* @typedef DummyResponse
|
|
224
232
|
* @property {string} [message]
|
|
@@ -282,9 +290,19 @@ export = ThemePlatformModel;
|
|
|
282
290
|
* @property {string} [_id] - The unique identifier for the marketplace theme.
|
|
283
291
|
* @property {string} [created_at] - Creation date of the theme
|
|
284
292
|
* @property {boolean} [is_default] - Whether the theme is the default theme.
|
|
285
|
-
* @property {
|
|
293
|
+
* @property {Release} [release]
|
|
286
294
|
* @property {string} [updated_at] - Update date of the theme
|
|
287
295
|
*/
|
|
296
|
+
/**
|
|
297
|
+
* @typedef OrderTracking
|
|
298
|
+
* @property {boolean} [show_footer]
|
|
299
|
+
* @property {boolean} [show_header]
|
|
300
|
+
*/
|
|
301
|
+
/**
|
|
302
|
+
* @typedef OverlayPopup
|
|
303
|
+
* @property {string} [dialog_backgroung]
|
|
304
|
+
* @property {string} [overlay]
|
|
305
|
+
*/
|
|
288
306
|
/**
|
|
289
307
|
* @typedef Page
|
|
290
308
|
* @property {number} [current]
|
|
@@ -312,6 +330,7 @@ export = ThemePlatformModel;
|
|
|
312
330
|
* @property {string} [info] - Additional information about the property
|
|
313
331
|
* @property {string} [label] - The label of the property
|
|
314
332
|
* @property {string} [type] - The type of the property
|
|
333
|
+
* @property {string} [value] - The value of the property
|
|
315
334
|
*/
|
|
316
335
|
/**
|
|
317
336
|
* @typedef RangeProp
|
|
@@ -323,10 +342,6 @@ export = ThemePlatformModel;
|
|
|
323
342
|
* @property {string} [notes] - The release notes of the theme
|
|
324
343
|
* @property {string} [version] - The version of the theme
|
|
325
344
|
*/
|
|
326
|
-
/**
|
|
327
|
-
* @typedef ReleaseVersionOnly
|
|
328
|
-
* @property {string} [version] - The version of the theme
|
|
329
|
-
*/
|
|
330
345
|
/**
|
|
331
346
|
* @typedef Route
|
|
332
347
|
* @property {string} [exact_url] - The exact URL of the route.
|
|
@@ -389,12 +404,20 @@ export = ThemePlatformModel;
|
|
|
389
404
|
* @property {string} [type] - The type of the property.
|
|
390
405
|
* @property {string} [value] - The value of the text property.
|
|
391
406
|
*/
|
|
407
|
+
/**
|
|
408
|
+
* @typedef ThemeConfigListPage
|
|
409
|
+
* @property {string} [page] - Name of the page
|
|
410
|
+
* @property {ThemeConfigListPageSettingsProps} [settings]
|
|
411
|
+
*/
|
|
412
|
+
/**
|
|
413
|
+
* @typedef ThemeConfigListPageSettingsProps
|
|
414
|
+
* @property {Object} [props]
|
|
415
|
+
*/
|
|
392
416
|
/**
|
|
393
417
|
* @typedef ThemeConfiguration
|
|
394
|
-
* @property {CustomConfig} [custom]
|
|
395
418
|
* @property {Object} [global_config]
|
|
396
419
|
* @property {string} [name] - The name of the configuration
|
|
397
|
-
* @property {
|
|
420
|
+
* @property {ThemeConfigListPage[]} [page] - An array of pages
|
|
398
421
|
*/
|
|
399
422
|
/**
|
|
400
423
|
* @typedef ThemeImages
|
|
@@ -436,6 +459,7 @@ export = ThemePlatformModel;
|
|
|
436
459
|
* @property {string} [marketplace_theme_id] - The ID of the theme in the marketplace
|
|
437
460
|
* @property {ThemeMeta} [meta]
|
|
438
461
|
* @property {string} [name] - The name of the theme
|
|
462
|
+
* @property {string} [src]
|
|
439
463
|
* @property {Object} [styles] - The styles associated with the theme
|
|
440
464
|
* @property {string[]} [tags] - An array of tags associated with the theme
|
|
441
465
|
* @property {string} [template_theme_id] - The ID of the template theme
|
|
@@ -461,6 +485,7 @@ export = ThemePlatformModel;
|
|
|
461
485
|
*/
|
|
462
486
|
/**
|
|
463
487
|
* @typedef UMDJs
|
|
488
|
+
* @property {string} [link]
|
|
464
489
|
* @property {string[]} [links] - An array of pages
|
|
465
490
|
*/
|
|
466
491
|
/**
|
|
@@ -477,6 +502,15 @@ export = ThemePlatformModel;
|
|
|
477
502
|
* @property {string} [type] - The type of the property.
|
|
478
503
|
* @property {string} [value] - The value of the URL property.
|
|
479
504
|
*/
|
|
505
|
+
/**
|
|
506
|
+
* @typedef UserAlerts
|
|
507
|
+
* @property {string} [error_background]
|
|
508
|
+
* @property {string} [error_text]
|
|
509
|
+
* @property {string} [info_background]
|
|
510
|
+
* @property {string} [info_text]
|
|
511
|
+
* @property {string} [success_background]
|
|
512
|
+
* @property {string} [success_text]
|
|
513
|
+
*/
|
|
480
514
|
/**
|
|
481
515
|
* @typedef {| "about-us"
|
|
482
516
|
* | "addresses"
|
|
@@ -528,7 +562,7 @@ export = ThemePlatformModel;
|
|
|
528
562
|
declare class ThemePlatformModel {
|
|
529
563
|
}
|
|
530
564
|
declare namespace ThemePlatformModel {
|
|
531
|
-
export { Action, ActionPage, AddThemeRequestSchema, AllAvailablePageSchema, AppliedThemes, Assets, AvailablePagePlatformPredicate, AvailablePagePredicate, AvailablePageRoutePredicate, AvailablePageSchedulePredicate, AvailablePageSchema, AvailablePageSchemaSections, AvailablePageScreenPredicate, AvailablePageSectionMetaAttributes, AvailablePageSeo, AvailablePageUserPredicate, BlitzkriegApiErrorSchema, BlitzkriegInternalServerErrorSchema, Block, BlockProps, CheckboxProp, CommonJS, CompanyPrivateTheme, CompanyThemeMeta, CompanyThemeSchema, Config, CSS, CustomConfig, CustomProps, DummyResponse, Font, FontsSchema, FontsSchemaItems, FontsSchemaItemsFiles, FontVariant, FontVariants, GlobalSchema, ImagePickerProp, Images, MarketplaceThemeId, Page, Predicate, Preset, Prop, RangeProp, Release,
|
|
565
|
+
export { Action, ActionPage, AddThemeRequestSchema, AllAvailablePageSchema, AppliedThemes, Assets, AvailablePagePlatformPredicate, AvailablePagePredicate, AvailablePageRoutePredicate, AvailablePageSchedulePredicate, AvailablePageSchema, AvailablePageSchemaSections, AvailablePageScreenPredicate, AvailablePageSectionMetaAttributes, AvailablePageSeo, AvailablePageUserPredicate, BlitzkriegApiErrorSchema, BlitzkriegInternalServerErrorSchema, Block, BlockProps, CheckboxProp, CommonJS, CompanyPrivateTheme, CompanyThemeMeta, CompanyThemeSchema, Config, CSS, CustomConfig, CustomProps, DividerStrokeHighlight, DummyResponse, Font, FontsSchema, FontsSchemaItems, FontsSchemaItemsFiles, FontVariant, FontVariants, GlobalSchema, ImagePickerProp, Images, MarketplaceThemeId, OrderTracking, OverlayPopup, Page, Predicate, Preset, Prop, RangeProp, Release, Route, Screen, Section, SectionItem, SectionPreset, SectionProps, SEObreadcrumb, SEOMetaItem, SEOMetaItems, SEOSitemap, TextProp, ThemeConfigListPage, ThemeConfigListPageSettingsProps, ThemeConfiguration, ThemeImages, ThemeMeta, ThemePayment, ThemeReq, ThemesSchema, ThemeUpgradableResponse, ThemeUserSchema, ThemeVersions, UMDJs, UpdateThemeNameRequestBody, UpdateThemeRequestBody, UrlProp, UserAlerts, PageType };
|
|
532
566
|
}
|
|
533
567
|
/** @returns {Action} */
|
|
534
568
|
declare function Action(): Action;
|
|
@@ -621,6 +655,10 @@ type AvailablePageSchedulePredicate = {
|
|
|
621
655
|
declare function AvailablePageSchema(): AvailablePageSchema;
|
|
622
656
|
type AvailablePageSchema = {
|
|
623
657
|
_id?: string;
|
|
658
|
+
/**
|
|
659
|
+
* - The creation timestamp of the page
|
|
660
|
+
*/
|
|
661
|
+
created_at?: string;
|
|
624
662
|
path?: string;
|
|
625
663
|
props?: any[];
|
|
626
664
|
sections?: AvailablePageSchemaSections[];
|
|
@@ -629,6 +667,10 @@ type AvailablePageSchema = {
|
|
|
629
667
|
text?: string;
|
|
630
668
|
theme?: string;
|
|
631
669
|
type?: string;
|
|
670
|
+
/**
|
|
671
|
+
* - The last update timestamp of the page
|
|
672
|
+
*/
|
|
673
|
+
updated_at?: string;
|
|
632
674
|
value?: string;
|
|
633
675
|
};
|
|
634
676
|
/** @returns {AvailablePageSchemaSections} */
|
|
@@ -640,6 +682,7 @@ type AvailablePageSchemaSections = {
|
|
|
640
682
|
predicate?: AvailablePagePredicate;
|
|
641
683
|
preset?: any;
|
|
642
684
|
props?: any;
|
|
685
|
+
source?: string;
|
|
643
686
|
};
|
|
644
687
|
/** @returns {AvailablePageScreenPredicate} */
|
|
645
688
|
declare function AvailablePageScreenPredicate(): AvailablePageScreenPredicate;
|
|
@@ -658,7 +701,6 @@ declare function AvailablePageSeo(): AvailablePageSeo;
|
|
|
658
701
|
type AvailablePageSeo = {
|
|
659
702
|
_id?: string;
|
|
660
703
|
breadcrumb?: SEObreadcrumb[];
|
|
661
|
-
canonical_url?: string;
|
|
662
704
|
description?: string;
|
|
663
705
|
meta_tags?: SEOMetaItem[];
|
|
664
706
|
sitemap?: SEOSitemap;
|
|
@@ -820,6 +862,7 @@ type Config = {
|
|
|
820
862
|
/** @returns {CSS} */
|
|
821
863
|
declare function CSS(): CSS;
|
|
822
864
|
type CSS = {
|
|
865
|
+
link?: string;
|
|
823
866
|
links?: string[];
|
|
824
867
|
};
|
|
825
868
|
/** @returns {CustomConfig} */
|
|
@@ -956,6 +999,12 @@ type CustomProps = {
|
|
|
956
999
|
*/
|
|
957
1000
|
text_strikethrough_price_color?: string;
|
|
958
1001
|
};
|
|
1002
|
+
/** @returns {DividerStrokeHighlight} */
|
|
1003
|
+
declare function DividerStrokeHighlight(): DividerStrokeHighlight;
|
|
1004
|
+
type DividerStrokeHighlight = {
|
|
1005
|
+
divider_strokes?: string;
|
|
1006
|
+
highlight?: string;
|
|
1007
|
+
};
|
|
959
1008
|
/** @returns {DummyResponse} */
|
|
960
1009
|
declare function DummyResponse(): DummyResponse;
|
|
961
1010
|
type DummyResponse = {
|
|
@@ -1060,12 +1109,24 @@ type MarketplaceThemeId = {
|
|
|
1060
1109
|
* - Whether the theme is the default theme.
|
|
1061
1110
|
*/
|
|
1062
1111
|
is_default?: boolean;
|
|
1063
|
-
release?:
|
|
1112
|
+
release?: Release;
|
|
1064
1113
|
/**
|
|
1065
1114
|
* - Update date of the theme
|
|
1066
1115
|
*/
|
|
1067
1116
|
updated_at?: string;
|
|
1068
1117
|
};
|
|
1118
|
+
/** @returns {OrderTracking} */
|
|
1119
|
+
declare function OrderTracking(): OrderTracking;
|
|
1120
|
+
type OrderTracking = {
|
|
1121
|
+
show_footer?: boolean;
|
|
1122
|
+
show_header?: boolean;
|
|
1123
|
+
};
|
|
1124
|
+
/** @returns {OverlayPopup} */
|
|
1125
|
+
declare function OverlayPopup(): OverlayPopup;
|
|
1126
|
+
type OverlayPopup = {
|
|
1127
|
+
dialog_backgroung?: string;
|
|
1128
|
+
overlay?: string;
|
|
1129
|
+
};
|
|
1069
1130
|
/** @returns {Page} */
|
|
1070
1131
|
declare function Page(): Page;
|
|
1071
1132
|
type Page = {
|
|
@@ -1112,6 +1173,10 @@ type Prop = {
|
|
|
1112
1173
|
* - The type of the property
|
|
1113
1174
|
*/
|
|
1114
1175
|
type?: string;
|
|
1176
|
+
/**
|
|
1177
|
+
* - The value of the property
|
|
1178
|
+
*/
|
|
1179
|
+
value?: string;
|
|
1115
1180
|
};
|
|
1116
1181
|
/** @returns {RangeProp} */
|
|
1117
1182
|
declare function RangeProp(): RangeProp;
|
|
@@ -1137,14 +1202,6 @@ type Release = {
|
|
|
1137
1202
|
*/
|
|
1138
1203
|
version?: string;
|
|
1139
1204
|
};
|
|
1140
|
-
/** @returns {ReleaseVersionOnly} */
|
|
1141
|
-
declare function ReleaseVersionOnly(): ReleaseVersionOnly;
|
|
1142
|
-
type ReleaseVersionOnly = {
|
|
1143
|
-
/**
|
|
1144
|
-
* - The version of the theme
|
|
1145
|
-
*/
|
|
1146
|
-
version?: string;
|
|
1147
|
-
};
|
|
1148
1205
|
/** @returns {Route} */
|
|
1149
1206
|
declare function Route(): Route;
|
|
1150
1207
|
type Route = {
|
|
@@ -1251,10 +1308,23 @@ type TextProp = {
|
|
|
1251
1308
|
*/
|
|
1252
1309
|
value?: string;
|
|
1253
1310
|
};
|
|
1311
|
+
/** @returns {ThemeConfigListPage} */
|
|
1312
|
+
declare function ThemeConfigListPage(): ThemeConfigListPage;
|
|
1313
|
+
type ThemeConfigListPage = {
|
|
1314
|
+
/**
|
|
1315
|
+
* - Name of the page
|
|
1316
|
+
*/
|
|
1317
|
+
page?: string;
|
|
1318
|
+
settings?: ThemeConfigListPageSettingsProps;
|
|
1319
|
+
};
|
|
1320
|
+
/** @returns {ThemeConfigListPageSettingsProps} */
|
|
1321
|
+
declare function ThemeConfigListPageSettingsProps(): ThemeConfigListPageSettingsProps;
|
|
1322
|
+
type ThemeConfigListPageSettingsProps = {
|
|
1323
|
+
props?: any;
|
|
1324
|
+
};
|
|
1254
1325
|
/** @returns {ThemeConfiguration} */
|
|
1255
1326
|
declare function ThemeConfiguration(): ThemeConfiguration;
|
|
1256
1327
|
type ThemeConfiguration = {
|
|
1257
|
-
custom?: CustomConfig;
|
|
1258
1328
|
global_config?: any;
|
|
1259
1329
|
/**
|
|
1260
1330
|
* - The name of the configuration
|
|
@@ -1263,7 +1333,7 @@ type ThemeConfiguration = {
|
|
|
1263
1333
|
/**
|
|
1264
1334
|
* - An array of pages
|
|
1265
1335
|
*/
|
|
1266
|
-
page?:
|
|
1336
|
+
page?: ThemeConfigListPage[];
|
|
1267
1337
|
};
|
|
1268
1338
|
/** @returns {ThemeImages} */
|
|
1269
1339
|
declare function ThemeImages(): ThemeImages;
|
|
@@ -1364,6 +1434,7 @@ type ThemesSchema = {
|
|
|
1364
1434
|
* - The name of the theme
|
|
1365
1435
|
*/
|
|
1366
1436
|
name?: string;
|
|
1437
|
+
src?: string;
|
|
1367
1438
|
/**
|
|
1368
1439
|
* - The styles associated with the theme
|
|
1369
1440
|
*/
|
|
@@ -1426,6 +1497,7 @@ type ThemeVersions = {
|
|
|
1426
1497
|
/** @returns {UMDJs} */
|
|
1427
1498
|
declare function UMDJs(): UMDJs;
|
|
1428
1499
|
type UMDJs = {
|
|
1500
|
+
link?: string;
|
|
1429
1501
|
/**
|
|
1430
1502
|
* - An array of pages
|
|
1431
1503
|
*/
|
|
@@ -1457,6 +1529,16 @@ type UrlProp = {
|
|
|
1457
1529
|
*/
|
|
1458
1530
|
value?: string;
|
|
1459
1531
|
};
|
|
1532
|
+
/** @returns {UserAlerts} */
|
|
1533
|
+
declare function UserAlerts(): UserAlerts;
|
|
1534
|
+
type UserAlerts = {
|
|
1535
|
+
error_background?: string;
|
|
1536
|
+
error_text?: string;
|
|
1537
|
+
info_background?: string;
|
|
1538
|
+
info_text?: string;
|
|
1539
|
+
success_background?: string;
|
|
1540
|
+
success_text?: string;
|
|
1541
|
+
};
|
|
1460
1542
|
/**
|
|
1461
1543
|
* Enum: PageType Used By: Theme
|
|
1462
1544
|
*
|