@gofynd/fdk-client-javascript 3.16.3 → 3.17.0

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.
Files changed (70) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/ApplicationClient.d.ts +0 -2
  4. package/sdk/application/ApplicationClient.js +0 -2
  5. package/sdk/application/Content/ContentApplicationClient.d.ts +10 -0
  6. package/sdk/application/Content/ContentApplicationClient.js +53 -0
  7. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +11 -21
  8. package/sdk/application/Logistic/LogisticApplicationClient.js +34 -83
  9. package/sdk/application/Order/OrderApplicationClient.d.ts +11 -0
  10. package/sdk/application/Order/OrderApplicationClient.js +50 -0
  11. package/sdk/application/Payment/PaymentApplicationClient.d.ts +4 -4
  12. package/sdk/application/Payment/PaymentApplicationClient.js +3 -4
  13. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +84 -0
  14. package/sdk/partner/Logistics/LogisticsPartnerClient.js +712 -0
  15. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +237 -1
  16. package/sdk/partner/Logistics/LogisticsPartnerModel.js +157 -0
  17. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +8 -0
  18. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +70 -0
  19. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +3 -3
  20. package/sdk/platform/Cart/CartPlatformApplicationClient.js +3 -3
  21. package/sdk/platform/Cart/CartPlatformModel.d.ts +1 -4
  22. package/sdk/platform/Cart/CartPlatformModel.js +1 -1
  23. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +2 -2
  24. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2 -2
  25. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +0 -11
  26. package/sdk/platform/Catalog/CatalogPlatformClient.js +0 -80
  27. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6 -131
  28. package/sdk/platform/Catalog/CatalogPlatformModel.js +4 -141
  29. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1 -10
  30. package/sdk/platform/Catalog/CatalogPlatformValidator.js +0 -12
  31. package/sdk/platform/Common/CommonPlatformModel.d.ts +18 -1
  32. package/sdk/platform/Common/CommonPlatformModel.js +14 -0
  33. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +1 -73
  34. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +4 -462
  35. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +7 -45
  36. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +4 -55
  37. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +10 -2
  38. package/sdk/platform/Communication/CommunicationPlatformModel.js +3 -2
  39. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +14 -0
  40. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +6 -0
  41. package/sdk/platform/Order/OrderPlatformClient.d.ts +26 -18
  42. package/sdk/platform/Order/OrderPlatformClient.js +175 -107
  43. package/sdk/platform/Order/OrderPlatformModel.d.ts +339 -43
  44. package/sdk/platform/Order/OrderPlatformModel.js +209 -43
  45. package/sdk/platform/Order/OrderPlatformValidator.d.ts +40 -43
  46. package/sdk/platform/Order/OrderPlatformValidator.js +35 -30
  47. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +20 -10
  48. package/sdk/platform/Payment/PaymentPlatformModel.js +14 -10
  49. package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
  50. package/sdk/platform/PlatformApplicationClient.js +0 -4
  51. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +0 -13
  52. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +0 -82
  53. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +1 -10
  54. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +0 -12
  55. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +212 -28
  56. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +133 -13
  57. package/sdk/platform/User/UserPlatformModel.d.ts +2 -2
  58. package/sdk/platform/User/UserPlatformModel.js +4 -4
  59. package/sdk/platform/index.d.ts +0 -1
  60. package/sdk/platform/index.js +0 -2
  61. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +27 -1
  62. package/sdk/public/Configuration/ConfigurationPublicModel.js +19 -0
  63. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +0 -79
  64. package/sdk/application/Rewards/RewardsApplicationClient.js +0 -315
  65. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +0 -136
  66. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +0 -976
  67. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +0 -152
  68. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +0 -157
  69. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +0 -387
  70. package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -410
@@ -3,9 +3,6 @@ export = CommunicationPlatformApplicationValidator;
3
3
  * @typedef CreateAudienceParam
4
4
  * @property {CommunicationPlatformModel.AudienceReq} body
5
5
  */
6
- /** @typedef CreateBigQueryHeadersParam */
7
- /** @typedef CreateBigQueryNCountParam */
8
- /** @typedef CreateBigQueryRowCountParam */
9
6
  /**
10
7
  * @typedef CreateCampaignParam
11
8
  * @property {CommunicationPlatformModel.CampaignReq} body
@@ -80,14 +77,6 @@ export = CommunicationPlatformApplicationValidator;
80
77
  * @property {Object} [sort] - To sort based on created_at
81
78
  * @property {Object} [query] - To search based on plain text
82
79
  */
83
- /**
84
- * @typedef GetBigQueryHeadersByIdParam
85
- * @property {string} id - Audience id
86
- */
87
- /**
88
- * @typedef GetBigQueryRowCountByIdParam
89
- * @property {string} id - Audience id
90
- */
91
80
  /**
92
81
  * @typedef GetCampaignByIdParam
93
82
  * @property {string} id - Campaign id
@@ -145,8 +134,9 @@ export = CommunicationPlatformApplicationValidator;
145
134
  * @property {string} [subGroup] - Filter by event subgroup. Here, a subgroup is
146
135
  * a subset within a group, containing specific email and SMS templates for
147
136
  * more detailed organization.
148
- * @property {string} [fulfillmentOptionTypes] - Filter by fulfillment option
149
- * type. Indicates the delivery choice selected, e.g., standard or express.
137
+ * @property {string} [fulfillmentOptionSlug] - Filter by fulfillment option
138
+ * slug. Indicates the delivery choice selected, e.g., standard-delivery or
139
+ * homedelivery.
150
140
  */
151
141
  /**
152
142
  * @typedef GetEventSubscriptionsByIdParam
@@ -213,7 +203,6 @@ export = CommunicationPlatformApplicationValidator;
213
203
  * @property {number} [pageSize] - Current request items count
214
204
  * @property {Object} [query] - To search based on plain text
215
205
  */
216
- /** @typedef GetSystemAudiencesParam */
217
206
  /** @typedef GetSystemEmailTemplatesParam */
218
207
  /** @typedef GetSystemSmsTemplatesParam */
219
208
  /**
@@ -278,12 +267,6 @@ export = CommunicationPlatformApplicationValidator;
278
267
  declare class CommunicationPlatformApplicationValidator {
279
268
  /** @returns {CreateAudienceParam} */
280
269
  static createAudience(): CreateAudienceParam;
281
- /** @returns {CreateBigQueryHeadersParam} */
282
- static createBigQueryHeaders(): any;
283
- /** @returns {CreateBigQueryNCountParam} */
284
- static createBigQueryNCount(): any;
285
- /** @returns {CreateBigQueryRowCountParam} */
286
- static createBigQueryRowCount(): any;
287
270
  /** @returns {CreateCampaignParam} */
288
271
  static createCampaign(): CreateCampaignParam;
289
272
  /** @returns {CreateEmailProviderParam} */
@@ -320,10 +303,6 @@ declare class CommunicationPlatformApplicationValidator {
320
303
  static getAudienceById(): GetAudienceByIdParam;
321
304
  /** @returns {GetAudiencesParam} */
322
305
  static getAudiences(): GetAudiencesParam;
323
- /** @returns {GetBigQueryHeadersByIdParam} */
324
- static getBigQueryHeadersById(): GetBigQueryHeadersByIdParam;
325
- /** @returns {GetBigQueryRowCountByIdParam} */
326
- static getBigQueryRowCountById(): GetBigQueryRowCountByIdParam;
327
306
  /** @returns {GetCampaignByIdParam} */
328
307
  static getCampaignById(): GetCampaignByIdParam;
329
308
  /** @returns {GetCampaignsParam} */
@@ -376,8 +355,6 @@ declare class CommunicationPlatformApplicationValidator {
376
355
  static getSubscribedEmailTemplates(): GetSubscribedEmailTemplatesParam;
377
356
  /** @returns {GetSubscribedSmsTemplatesParam} */
378
357
  static getSubscribedSmsTemplates(): GetSubscribedSmsTemplatesParam;
379
- /** @returns {GetSystemAudiencesParam} */
380
- static getSystemAudiences(): any;
381
358
  /** @returns {GetSystemEmailTemplatesParam} */
382
359
  static getSystemEmailTemplates(): any;
383
360
  /** @returns {GetSystemSmsTemplatesParam} */
@@ -412,7 +389,7 @@ declare class CommunicationPlatformApplicationValidator {
412
389
  static verfiyOtp(): VerfiyOtpParam;
413
390
  }
414
391
  declare namespace CommunicationPlatformApplicationValidator {
415
- export { CreateAudienceParam, CreateBigQueryHeadersParam, CreateBigQueryNCountParam, CreateBigQueryRowCountParam, CreateCampaignParam, CreateEmailProviderParam, CreateEmailTemplateParam, CreateEventSubscriptionsParam, CreateEventSubscriptionsByBulkParam, CreateJobsParam, CreateSmsProviderParam, CreateSmsTemplateParam, DeleteAudienceByIdParam, DeleteEmailProviderByIdParam, DeleteEmailTemplateByIdParam, DeleteEventSubscriptionsByIdParam, DeleteSmsProviderByIdParam, DeleteSmsTemplateByIdParam, EditEventSubscriptionsParam, GetAppProvidersParam, GetAudienceByIdParam, GetAudiencesParam, GetBigQueryHeadersByIdParam, GetBigQueryRowCountByIdParam, GetCampaignByIdParam, GetCampaignsParam, GetCommunicationLogsParam, GetDefaultSmsProvidersParam, GetDummyDatasourcesParam, GetDummyDatasourcesMetaParam, GetEmailProviderByIdParam, GetEmailProvidersParam, GetEmailTemplateByIdParam, GetEmailTemplatesParam, GetEventSubscriptionsParam, GetEventSubscriptionsByIdParam, GetGlobalProvidersParam, GetGlobalVariablesParam, GetJobLogsParam, GetJobsParam, GetNSampleRecordsFromCsvParam, GetNSampleRecordsFromCsvByGetParam, GetOtpConfigurationParam, GetSmsProviderByIdParam, GetSmsProvidersParam, GetSmsTemplateByIdParam, GetSmsTemplatesParam, GetStatsOfCampaignByIdParam, GetSubscribedEmailTemplatesParam, GetSubscribedSmsTemplatesParam, GetSystemAudiencesParam, GetSystemEmailTemplatesParam, GetSystemSmsTemplatesParam, PostGlobalVariablesParam, SendCommunicationAsynchronouslyParam, SendCommunicationSynchronouslyParam, SendOtpParam, TriggerCampaignJobParam, UpdateAppProvidersParam, UpdateAudienceByIdParam, UpdateCampaignByIdParam, UpdateEmailProviderByIdParam, UpdateEmailTemplateByIdParam, UpdateOtpConfigurationParam, UpdateSmsProviderByIdParam, UpdateSmsTemplateByIdParam, VerfiyOtpParam };
392
+ export { CreateAudienceParam, CreateCampaignParam, CreateEmailProviderParam, CreateEmailTemplateParam, CreateEventSubscriptionsParam, CreateEventSubscriptionsByBulkParam, CreateJobsParam, CreateSmsProviderParam, CreateSmsTemplateParam, DeleteAudienceByIdParam, DeleteEmailProviderByIdParam, DeleteEmailTemplateByIdParam, DeleteEventSubscriptionsByIdParam, DeleteSmsProviderByIdParam, DeleteSmsTemplateByIdParam, EditEventSubscriptionsParam, GetAppProvidersParam, GetAudienceByIdParam, GetAudiencesParam, GetCampaignByIdParam, GetCampaignsParam, GetCommunicationLogsParam, GetDefaultSmsProvidersParam, GetDummyDatasourcesParam, GetDummyDatasourcesMetaParam, GetEmailProviderByIdParam, GetEmailProvidersParam, GetEmailTemplateByIdParam, GetEmailTemplatesParam, GetEventSubscriptionsParam, GetEventSubscriptionsByIdParam, GetGlobalProvidersParam, GetGlobalVariablesParam, GetJobLogsParam, GetJobsParam, GetNSampleRecordsFromCsvParam, GetNSampleRecordsFromCsvByGetParam, GetOtpConfigurationParam, GetSmsProviderByIdParam, GetSmsProvidersParam, GetSmsTemplateByIdParam, GetSmsTemplatesParam, GetStatsOfCampaignByIdParam, GetSubscribedEmailTemplatesParam, GetSubscribedSmsTemplatesParam, GetSystemEmailTemplatesParam, GetSystemSmsTemplatesParam, PostGlobalVariablesParam, SendCommunicationAsynchronouslyParam, SendCommunicationSynchronouslyParam, SendOtpParam, TriggerCampaignJobParam, UpdateAppProvidersParam, UpdateAudienceByIdParam, UpdateCampaignByIdParam, UpdateEmailProviderByIdParam, UpdateEmailTemplateByIdParam, UpdateOtpConfigurationParam, UpdateSmsProviderByIdParam, UpdateSmsTemplateByIdParam, VerfiyOtpParam };
416
393
  }
417
394
  type CreateAudienceParam = {
418
395
  body: CommunicationPlatformModel.AudienceReq;
@@ -509,18 +486,6 @@ type GetAudiencesParam = {
509
486
  */
510
487
  query?: any;
511
488
  };
512
- type GetBigQueryHeadersByIdParam = {
513
- /**
514
- * - Audience id
515
- */
516
- id: string;
517
- };
518
- type GetBigQueryRowCountByIdParam = {
519
- /**
520
- * - Audience id
521
- */
522
- id: string;
523
- };
524
489
  type GetCampaignByIdParam = {
525
490
  /**
526
491
  * - Campaign id
@@ -641,9 +606,10 @@ type GetEventSubscriptionsParam = {
641
606
  subGroup?: string;
642
607
  /**
643
608
  * - Filter by fulfillment option
644
- * type. Indicates the delivery choice selected, e.g., standard or express.
609
+ * slug. Indicates the delivery choice selected, e.g., standard-delivery or
610
+ * homedelivery.
645
611
  */
646
- fulfillmentOptionTypes?: string;
612
+ fulfillmentOptionSlug?: string;
647
613
  };
648
614
  type GetEventSubscriptionsByIdParam = {
649
615
  /**
@@ -839,9 +805,6 @@ type UpdateSmsTemplateByIdParam = {
839
805
  type VerfiyOtpParam = {
840
806
  body: CommunicationPlatformModel.VerifyOtpCommsReq;
841
807
  };
842
- type CreateBigQueryHeadersParam = any;
843
- type CreateBigQueryNCountParam = any;
844
- type CreateBigQueryRowCountParam = any;
845
808
  type GetAppProvidersParam = any;
846
809
  type GetDefaultSmsProvidersParam = any;
847
810
  type GetDummyDatasourcesParam = any;
@@ -849,7 +812,6 @@ type GetGlobalProvidersParam = any;
849
812
  type GetGlobalVariablesParam = any;
850
813
  type GetNSampleRecordsFromCsvByGetParam = any;
851
814
  type GetOtpConfigurationParam = any;
852
- type GetSystemAudiencesParam = any;
853
815
  type GetSystemEmailTemplatesParam = any;
854
816
  type GetSystemSmsTemplatesParam = any;
855
817
  type UpdateOtpConfigurationParam = any;
@@ -7,12 +7,6 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
7
7
  * @property {CommunicationPlatformModel.AudienceReq} body
8
8
  */
9
9
 
10
- /** @typedef CreateBigQueryHeadersParam */
11
-
12
- /** @typedef CreateBigQueryNCountParam */
13
-
14
- /** @typedef CreateBigQueryRowCountParam */
15
-
16
10
  /**
17
11
  * @typedef CreateCampaignParam
18
12
  * @property {CommunicationPlatformModel.CampaignReq} body
@@ -105,16 +99,6 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
105
99
  * @property {Object} [query] - To search based on plain text
106
100
  */
107
101
 
108
- /**
109
- * @typedef GetBigQueryHeadersByIdParam
110
- * @property {string} id - Audience id
111
- */
112
-
113
- /**
114
- * @typedef GetBigQueryRowCountByIdParam
115
- * @property {string} id - Audience id
116
- */
117
-
118
102
  /**
119
103
  * @typedef GetCampaignByIdParam
120
104
  * @property {string} id - Campaign id
@@ -182,8 +166,9 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
182
166
  * @property {string} [subGroup] - Filter by event subgroup. Here, a subgroup is
183
167
  * a subset within a group, containing specific email and SMS templates for
184
168
  * more detailed organization.
185
- * @property {string} [fulfillmentOptionTypes] - Filter by fulfillment option
186
- * type. Indicates the delivery choice selected, e.g., standard or express.
169
+ * @property {string} [fulfillmentOptionSlug] - Filter by fulfillment option
170
+ * slug. Indicates the delivery choice selected, e.g., standard-delivery or
171
+ * homedelivery.
187
172
  */
188
173
 
189
174
  /**
@@ -266,8 +251,6 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
266
251
  * @property {Object} [query] - To search based on plain text
267
252
  */
268
253
 
269
- /** @typedef GetSystemAudiencesParam */
270
-
271
254
  /** @typedef GetSystemEmailTemplatesParam */
272
255
 
273
256
  /** @typedef GetSystemSmsTemplatesParam */
@@ -353,21 +336,6 @@ class CommunicationPlatformApplicationValidator {
353
336
  }).required();
354
337
  }
355
338
 
356
- /** @returns {CreateBigQueryHeadersParam} */
357
- static createBigQueryHeaders() {
358
- return Joi.object({}).required();
359
- }
360
-
361
- /** @returns {CreateBigQueryNCountParam} */
362
- static createBigQueryNCount() {
363
- return Joi.object({}).required();
364
- }
365
-
366
- /** @returns {CreateBigQueryRowCountParam} */
367
- static createBigQueryRowCount() {
368
- return Joi.object({}).required();
369
- }
370
-
371
339
  /** @returns {CreateCampaignParam} */
372
340
  static createCampaign() {
373
341
  return Joi.object({
@@ -497,20 +465,6 @@ class CommunicationPlatformApplicationValidator {
497
465
  }).required();
498
466
  }
499
467
 
500
- /** @returns {GetBigQueryHeadersByIdParam} */
501
- static getBigQueryHeadersById() {
502
- return Joi.object({
503
- id: Joi.string().allow("").required(),
504
- }).required();
505
- }
506
-
507
- /** @returns {GetBigQueryRowCountByIdParam} */
508
- static getBigQueryRowCountById() {
509
- return Joi.object({
510
- id: Joi.string().allow("").required(),
511
- }).required();
512
- }
513
-
514
468
  /** @returns {GetCampaignByIdParam} */
515
469
  static getCampaignById() {
516
470
  return Joi.object({
@@ -597,7 +551,7 @@ class CommunicationPlatformApplicationValidator {
597
551
  populate: Joi.string().allow(""),
598
552
  group: Joi.string().allow(""),
599
553
  subGroup: Joi.string().allow(""),
600
- fulfillmentOptionTypes: Joi.string().allow(""),
554
+ fulfillmentOptionSlug: Joi.string().allow(""),
601
555
  }).required();
602
556
  }
603
557
 
@@ -715,11 +669,6 @@ class CommunicationPlatformApplicationValidator {
715
669
  }).required();
716
670
  }
717
671
 
718
- /** @returns {GetSystemAudiencesParam} */
719
- static getSystemAudiences() {
720
- return Joi.object({}).required();
721
- }
722
-
723
672
  /** @returns {GetSystemEmailTemplatesParam} */
724
673
  static getSystemEmailTemplates() {
725
674
  return Joi.object({}).required();
@@ -1,13 +1,14 @@
1
1
  export = CommunicationPlatformModel;
2
2
  /**
3
3
  * @typedef GroupMapping
4
- * @property {EventGroup[]} items
4
+ * @property {EventGroup[]} items - List of event groups configured for the application.
5
5
  */
6
6
  /**
7
7
  * @typedef EventGroup
8
8
  * @property {string} name - Event group identifier
9
9
  * @property {string} display - Human-readable group name
10
- * @property {EventSubgroup[]} subgroups
10
+ * @property {EventSubgroup[]} subgroups - List of sub-groups that belong to
11
+ * this event group.
11
12
  */
12
13
  /**
13
14
  * @typedef EventSubgroup
@@ -904,6 +905,9 @@ declare namespace CommunicationPlatformModel {
904
905
  /** @returns {GroupMapping} */
905
906
  declare function GroupMapping(): GroupMapping;
906
907
  type GroupMapping = {
908
+ /**
909
+ * - List of event groups configured for the application.
910
+ */
907
911
  items: EventGroup[];
908
912
  };
909
913
  /** @returns {EventGroup} */
@@ -917,6 +921,10 @@ type EventGroup = {
917
921
  * - Human-readable group name
918
922
  */
919
923
  display: string;
924
+ /**
925
+ * - List of sub-groups that belong to
926
+ * this event group.
927
+ */
920
928
  subgroups: EventSubgroup[];
921
929
  };
922
930
  /** @returns {EventSubgroup} */
@@ -2,14 +2,15 @@ const Joi = require("joi");
2
2
 
3
3
  /**
4
4
  * @typedef GroupMapping
5
- * @property {EventGroup[]} items
5
+ * @property {EventGroup[]} items - List of event groups configured for the application.
6
6
  */
7
7
 
8
8
  /**
9
9
  * @typedef EventGroup
10
10
  * @property {string} name - Event group identifier
11
11
  * @property {string} display - Human-readable group name
12
- * @property {EventSubgroup[]} subgroups
12
+ * @property {EventSubgroup[]} subgroups - List of sub-groups that belong to
13
+ * this event group.
13
14
  */
14
15
 
15
16
  /**
@@ -374,6 +374,8 @@ export = CompanyProfilePlatformModel;
374
374
  * @property {LocationDayWiseSchema[]} [order_acceptance_timing]
375
375
  * @property {AverageOrderProcessingTime} [avg_order_processing_time]
376
376
  * @property {boolean} [bulk_shipment]
377
+ * @property {boolean} [multi_piece_shipment] - Flag indicating if multi-piece
378
+ * shipment is enabled for the location.
377
379
  * @property {boolean} [auto_assign_courier_partner]
378
380
  * @property {boolean} [qc_based_return_inventory_sync]
379
381
  */
@@ -430,6 +432,8 @@ export = CompanyProfilePlatformModel;
430
432
  * acceptance timing of the store
431
433
  * @property {AverageOrderProcessingTime} [avg_order_processing_time]
432
434
  * @property {boolean} [bulk_shipment]
435
+ * @property {boolean} [multi_piece_shipment] - Flag indicating if multi-piece
436
+ * shipment is enabled for the location.
433
437
  * @property {boolean} [auto_assign_courier_partner]
434
438
  */
435
439
  /**
@@ -895,6 +899,11 @@ type GetLocationSchema = {
895
899
  order_acceptance_timing?: LocationDayWiseSchema[];
896
900
  avg_order_processing_time?: AverageOrderProcessingTime;
897
901
  bulk_shipment?: boolean;
902
+ /**
903
+ * - Flag indicating if multi-piece
904
+ * shipment is enabled for the location.
905
+ */
906
+ multi_piece_shipment?: boolean;
898
907
  auto_assign_courier_partner?: boolean;
899
908
  qc_based_return_inventory_sync?: boolean;
900
909
  };
@@ -969,6 +978,11 @@ type LocationSchema = {
969
978
  order_acceptance_timing?: LocationDayWiseSchema[];
970
979
  avg_order_processing_time?: AverageOrderProcessingTime;
971
980
  bulk_shipment?: boolean;
981
+ /**
982
+ * - Flag indicating if multi-piece
983
+ * shipment is enabled for the location.
984
+ */
985
+ multi_piece_shipment?: boolean;
972
986
  auto_assign_courier_partner?: boolean;
973
987
  };
974
988
  /** @returns {BulkLocationSchema} */
@@ -413,6 +413,8 @@ const Joi = require("joi");
413
413
  * @property {LocationDayWiseSchema[]} [order_acceptance_timing]
414
414
  * @property {AverageOrderProcessingTime} [avg_order_processing_time]
415
415
  * @property {boolean} [bulk_shipment]
416
+ * @property {boolean} [multi_piece_shipment] - Flag indicating if multi-piece
417
+ * shipment is enabled for the location.
416
418
  * @property {boolean} [auto_assign_courier_partner]
417
419
  * @property {boolean} [qc_based_return_inventory_sync]
418
420
  */
@@ -472,6 +474,8 @@ const Joi = require("joi");
472
474
  * acceptance timing of the store
473
475
  * @property {AverageOrderProcessingTime} [avg_order_processing_time]
474
476
  * @property {boolean} [bulk_shipment]
477
+ * @property {boolean} [multi_piece_shipment] - Flag indicating if multi-piece
478
+ * shipment is enabled for the location.
475
479
  * @property {boolean} [auto_assign_courier_partner]
476
480
  */
477
481
 
@@ -1005,6 +1009,7 @@ class CompanyProfilePlatformModel {
1005
1009
  ),
1006
1010
  avg_order_processing_time: CompanyProfilePlatformModel.AverageOrderProcessingTime(),
1007
1011
  bulk_shipment: Joi.boolean(),
1012
+ multi_piece_shipment: Joi.boolean(),
1008
1013
  auto_assign_courier_partner: Joi.boolean(),
1009
1014
  qc_based_return_inventory_sync: Joi.boolean(),
1010
1015
  });
@@ -1075,6 +1080,7 @@ class CompanyProfilePlatformModel {
1075
1080
  ),
1076
1081
  avg_order_processing_time: CompanyProfilePlatformModel.AverageOrderProcessingTime(),
1077
1082
  bulk_shipment: Joi.boolean(),
1083
+ multi_piece_shipment: Joi.boolean(),
1078
1084
  auto_assign_courier_partner: Joi.boolean(),
1079
1085
  });
1080
1086
  }
@@ -89,15 +89,15 @@ declare class Order {
89
89
  */
90
90
  createOrder({ xOrderingSource, body, xApplicationId, xExtensionId, requestHeaders }?: OrderPlatformValidator.CreateOrderParam, { responseHeaders }?: object): Promise<any>;
91
91
  /**
92
- * @param {OrderPlatformValidator.CreateOrderDeprecatedParam} arg - Arg object
92
+ * @param {OrderPlatformValidator.CreateShipmentPackagesParam} arg - Arg object
93
93
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
94
94
  * @param {import("../PlatformAPIClient").Options} - Options
95
- * @returns {Promise<OrderPlatformModel.CreateOrderResponseSchema>} - Success response
96
- * @name createOrderDeprecated
97
- * @summary: Create order
98
- * @description: Creates an order - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/createOrderDeprecated/).
95
+ * @returns {Promise<OrderPlatformModel.BaseResponseSchema>} - Success response
96
+ * @name createShipmentPackages
97
+ * @summary: Create shipment packages
98
+ * @description: Create new packages for a shipment, enabling Multi-Piece Shipment (MPS) functionality. This operation validates courier partner availability and performs bag breaking as per number of packages. The system automatically validates MPS eligibility and store configuration before creating packages. If the store is not eligible for MPS, it will not let the user create packages. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/createShipmentPackages/).
99
99
  */
100
- createOrderDeprecated({ xOrderingSource, body, xApplicationId, xExtensionId, requestHeaders }?: OrderPlatformValidator.CreateOrderDeprecatedParam, { responseHeaders }?: object): Promise<OrderPlatformModel.CreateOrderResponseSchema>;
100
+ createShipmentPackages({ shipmentId, body, requestHeaders }?: OrderPlatformValidator.CreateShipmentPackagesParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BaseResponseSchema>;
101
101
  /**
102
102
  * @param {OrderPlatformValidator.DispatchManifestsParam} arg - Arg object
103
103
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -504,6 +504,16 @@ declare class Order {
504
504
  * @description: Get the history of the shipment - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getShipmentHistory/).
505
505
  */
506
506
  getShipmentHistory({ shipmentId, bagId, requestHeaders }?: OrderPlatformValidator.GetShipmentHistoryParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentHistoryResponseSchema>;
507
+ /**
508
+ * @param {OrderPlatformValidator.GetShipmentPackagesParam} arg - Arg object
509
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
510
+ * @param {import("../PlatformAPIClient").Options} - Options
511
+ * @returns {Promise<OrderPlatformModel.PackagesResponseSchema>} - Success response
512
+ * @name getShipmentPackages
513
+ * @summary: Get shipment packages
514
+ * @description: Retrieve all packages associated with a specific shipment. This endpoint supports both single-piece and multi-piece shipments. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getShipmentPackages/).
515
+ */
516
+ getShipmentPackages({ shipmentId, requestHeaders }?: OrderPlatformValidator.GetShipmentPackagesParam, { responseHeaders }?: object): Promise<OrderPlatformModel.PackagesResponseSchema>;
507
517
  /**
508
518
  * @param {OrderPlatformValidator.GetShipmentReasonsParam} arg - Arg object
509
519
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -698,18 +708,6 @@ declare class Order {
698
708
  * @description: Get supported filters for various listing operations - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/getfilters/).
699
709
  */
700
710
  getfilters({ view, groupEntity, requestHeaders }?: OrderPlatformValidator.GetfiltersParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FiltersResponseSchema>;
701
- /**
702
- * @param {OrderPlatformValidator.InvalidateShipmentCacheParam} arg - Arg object
703
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
704
- * @param {import("../PlatformAPIClient").Options} - Options
705
- * @returns {Promise<OrderPlatformModel.InvalidateShipmentCacheResponseSchema>}
706
- * - Success response
707
- *
708
- * @name invalidateShipmentCache
709
- * @summary: Invalidate shipment cache
710
- * @description: Clear the existing shipment cache data stored in Redis and serialize the updated data for subsequent use. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/invalidateShipmentCache/).
711
- */
712
- invalidateShipmentCache({ body, requestHeaders }?: OrderPlatformValidator.InvalidateShipmentCacheParam, { responseHeaders }?: object): Promise<OrderPlatformModel.InvalidateShipmentCacheResponseSchema>;
713
711
  /**
714
712
  * @param {OrderPlatformValidator.JobDetailsParam} arg - Arg object
715
713
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -849,6 +847,16 @@ declare class Order {
849
847
  * @description: Modify shipment/bag lock status and update lock/unlock messages. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updateShipmentLock/).
850
848
  */
851
849
  updateShipmentLock({ body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentLockParam, { responseHeaders }?: object): Promise<OrderPlatformModel.UpdateShipmentLockResponseSchema>;
850
+ /**
851
+ * @param {OrderPlatformValidator.UpdateShipmentPackagesParam} arg - Arg object
852
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
853
+ * @param {import("../PlatformAPIClient").Options} - Options
854
+ * @returns {Promise<OrderPlatformModel.BaseResponseSchema>} - Success response
855
+ * @name updateShipmentPackages
856
+ * @summary: Update shipment packages
857
+ * @description: Update existing packages for a shipment. This operation replaces all existing packages with the provided package list. The system validates courier partner availability and performs bag breaking as per number of packages. Any packages without IDs will have new unique IDs generated. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/order/updateShipmentPackages/).
858
+ */
859
+ updateShipmentPackages({ shipmentId, body, requestHeaders }?: OrderPlatformValidator.UpdateShipmentPackagesParam, { responseHeaders }?: object): Promise<OrderPlatformModel.BaseResponseSchema>;
852
860
  /**
853
861
  * @param {OrderPlatformValidator.UpdateShipmentStatusParam} arg - Arg object
854
862
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`