@gofynd/fdk-client-javascript 3.16.2 → 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 (82) hide show
  1. package/README.md +1 -1
  2. package/package.json +2 -2
  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/application/User/UserApplicationClient.d.ts +10 -0
  14. package/sdk/application/User/UserApplicationClient.js +67 -0
  15. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +84 -0
  16. package/sdk/partner/Logistics/LogisticsPartnerClient.js +712 -0
  17. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +237 -1
  18. package/sdk/partner/Logistics/LogisticsPartnerModel.js +157 -0
  19. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +8 -0
  20. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +70 -0
  21. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +3 -3
  22. package/sdk/platform/Cart/CartPlatformApplicationClient.js +3 -3
  23. package/sdk/platform/Cart/CartPlatformModel.d.ts +1 -4
  24. package/sdk/platform/Cart/CartPlatformModel.js +1 -1
  25. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +2 -2
  26. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2 -2
  27. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +0 -11
  28. package/sdk/platform/Catalog/CatalogPlatformClient.js +0 -80
  29. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6 -131
  30. package/sdk/platform/Catalog/CatalogPlatformModel.js +4 -141
  31. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1 -10
  32. package/sdk/platform/Catalog/CatalogPlatformValidator.js +0 -12
  33. package/sdk/platform/Common/CommonPlatformModel.d.ts +18 -1
  34. package/sdk/platform/Common/CommonPlatformModel.js +14 -0
  35. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +1 -73
  36. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +18 -459
  37. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +28 -41
  38. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +12 -52
  39. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +54 -1
  40. package/sdk/platform/Communication/CommunicationPlatformModel.js +47 -0
  41. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +14 -0
  42. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +6 -0
  43. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +1 -1
  44. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1 -7
  45. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +0 -14
  46. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +0 -6
  47. package/sdk/platform/Content/ContentPlatformModel.d.ts +0 -2
  48. package/sdk/platform/Content/ContentPlatformModel.js +0 -2
  49. package/sdk/platform/Order/OrderPlatformClient.d.ts +26 -18
  50. package/sdk/platform/Order/OrderPlatformClient.js +175 -107
  51. package/sdk/platform/Order/OrderPlatformModel.d.ts +339 -43
  52. package/sdk/platform/Order/OrderPlatformModel.js +209 -43
  53. package/sdk/platform/Order/OrderPlatformValidator.d.ts +40 -43
  54. package/sdk/platform/Order/OrderPlatformValidator.js +35 -30
  55. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +20 -10
  56. package/sdk/platform/Payment/PaymentPlatformModel.js +14 -10
  57. package/sdk/platform/PlatformApplicationClient.d.ts +0 -2
  58. package/sdk/platform/PlatformApplicationClient.js +0 -4
  59. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +0 -13
  60. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +0 -82
  61. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +1 -10
  62. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +0 -12
  63. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +212 -28
  64. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +133 -13
  65. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +10 -0
  66. package/sdk/platform/User/UserPlatformApplicationClient.js +79 -0
  67. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +13 -1
  68. package/sdk/platform/User/UserPlatformApplicationValidator.js +12 -0
  69. package/sdk/platform/User/UserPlatformModel.d.ts +42 -5
  70. package/sdk/platform/User/UserPlatformModel.js +25 -6
  71. package/sdk/platform/index.d.ts +0 -1
  72. package/sdk/platform/index.js +0 -2
  73. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +27 -1
  74. package/sdk/public/Configuration/ConfigurationPublicModel.js +19 -0
  75. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +0 -79
  76. package/sdk/application/Rewards/RewardsApplicationClient.js +0 -315
  77. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +0 -136
  78. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +0 -976
  79. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +0 -152
  80. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +0 -157
  81. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +0 -387
  82. 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
@@ -139,6 +128,15 @@ export = CommunicationPlatformApplicationValidator;
139
128
  * @property {number} [pageNo] - Current page no
140
129
  * @property {number} [pageSize] - Current request items count
141
130
  * @property {string} [populate] - Populate Fields
131
+ * @property {string} [group] - An event group is a collection of email and SMS
132
+ * templates. Filtering by event group lets you view or manage all related
133
+ * communication templates together.
134
+ * @property {string} [subGroup] - Filter by event subgroup. Here, a subgroup is
135
+ * a subset within a group, containing specific email and SMS templates for
136
+ * more detailed organization.
137
+ * @property {string} [fulfillmentOptionSlug] - Filter by fulfillment option
138
+ * slug. Indicates the delivery choice selected, e.g., standard-delivery or
139
+ * homedelivery.
142
140
  */
143
141
  /**
144
142
  * @typedef GetEventSubscriptionsByIdParam
@@ -205,7 +203,6 @@ export = CommunicationPlatformApplicationValidator;
205
203
  * @property {number} [pageSize] - Current request items count
206
204
  * @property {Object} [query] - To search based on plain text
207
205
  */
208
- /** @typedef GetSystemAudiencesParam */
209
206
  /** @typedef GetSystemEmailTemplatesParam */
210
207
  /** @typedef GetSystemSmsTemplatesParam */
211
208
  /**
@@ -270,12 +267,6 @@ export = CommunicationPlatformApplicationValidator;
270
267
  declare class CommunicationPlatformApplicationValidator {
271
268
  /** @returns {CreateAudienceParam} */
272
269
  static createAudience(): CreateAudienceParam;
273
- /** @returns {CreateBigQueryHeadersParam} */
274
- static createBigQueryHeaders(): any;
275
- /** @returns {CreateBigQueryNCountParam} */
276
- static createBigQueryNCount(): any;
277
- /** @returns {CreateBigQueryRowCountParam} */
278
- static createBigQueryRowCount(): any;
279
270
  /** @returns {CreateCampaignParam} */
280
271
  static createCampaign(): CreateCampaignParam;
281
272
  /** @returns {CreateEmailProviderParam} */
@@ -312,10 +303,6 @@ declare class CommunicationPlatformApplicationValidator {
312
303
  static getAudienceById(): GetAudienceByIdParam;
313
304
  /** @returns {GetAudiencesParam} */
314
305
  static getAudiences(): GetAudiencesParam;
315
- /** @returns {GetBigQueryHeadersByIdParam} */
316
- static getBigQueryHeadersById(): GetBigQueryHeadersByIdParam;
317
- /** @returns {GetBigQueryRowCountByIdParam} */
318
- static getBigQueryRowCountById(): GetBigQueryRowCountByIdParam;
319
306
  /** @returns {GetCampaignByIdParam} */
320
307
  static getCampaignById(): GetCampaignByIdParam;
321
308
  /** @returns {GetCampaignsParam} */
@@ -368,8 +355,6 @@ declare class CommunicationPlatformApplicationValidator {
368
355
  static getSubscribedEmailTemplates(): GetSubscribedEmailTemplatesParam;
369
356
  /** @returns {GetSubscribedSmsTemplatesParam} */
370
357
  static getSubscribedSmsTemplates(): GetSubscribedSmsTemplatesParam;
371
- /** @returns {GetSystemAudiencesParam} */
372
- static getSystemAudiences(): any;
373
358
  /** @returns {GetSystemEmailTemplatesParam} */
374
359
  static getSystemEmailTemplates(): any;
375
360
  /** @returns {GetSystemSmsTemplatesParam} */
@@ -404,7 +389,7 @@ declare class CommunicationPlatformApplicationValidator {
404
389
  static verfiyOtp(): VerfiyOtpParam;
405
390
  }
406
391
  declare namespace CommunicationPlatformApplicationValidator {
407
- 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 };
408
393
  }
409
394
  type CreateAudienceParam = {
410
395
  body: CommunicationPlatformModel.AudienceReq;
@@ -501,18 +486,6 @@ type GetAudiencesParam = {
501
486
  */
502
487
  query?: any;
503
488
  };
504
- type GetBigQueryHeadersByIdParam = {
505
- /**
506
- * - Audience id
507
- */
508
- id: string;
509
- };
510
- type GetBigQueryRowCountByIdParam = {
511
- /**
512
- * - Audience id
513
- */
514
- id: string;
515
- };
516
489
  type GetCampaignByIdParam = {
517
490
  /**
518
491
  * - Campaign id
@@ -619,6 +592,24 @@ type GetEventSubscriptionsParam = {
619
592
  * - Populate Fields
620
593
  */
621
594
  populate?: string;
595
+ /**
596
+ * - An event group is a collection of email and SMS
597
+ * templates. Filtering by event group lets you view or manage all related
598
+ * communication templates together.
599
+ */
600
+ group?: string;
601
+ /**
602
+ * - Filter by event subgroup. Here, a subgroup is
603
+ * a subset within a group, containing specific email and SMS templates for
604
+ * more detailed organization.
605
+ */
606
+ subGroup?: string;
607
+ /**
608
+ * - Filter by fulfillment option
609
+ * slug. Indicates the delivery choice selected, e.g., standard-delivery or
610
+ * homedelivery.
611
+ */
612
+ fulfillmentOptionSlug?: string;
622
613
  };
623
614
  type GetEventSubscriptionsByIdParam = {
624
615
  /**
@@ -814,9 +805,6 @@ type UpdateSmsTemplateByIdParam = {
814
805
  type VerfiyOtpParam = {
815
806
  body: CommunicationPlatformModel.VerifyOtpCommsReq;
816
807
  };
817
- type CreateBigQueryHeadersParam = any;
818
- type CreateBigQueryNCountParam = any;
819
- type CreateBigQueryRowCountParam = any;
820
808
  type GetAppProvidersParam = any;
821
809
  type GetDefaultSmsProvidersParam = any;
822
810
  type GetDummyDatasourcesParam = any;
@@ -824,7 +812,6 @@ type GetGlobalProvidersParam = any;
824
812
  type GetGlobalVariablesParam = any;
825
813
  type GetNSampleRecordsFromCsvByGetParam = any;
826
814
  type GetOtpConfigurationParam = any;
827
- type GetSystemAudiencesParam = any;
828
815
  type GetSystemEmailTemplatesParam = any;
829
816
  type GetSystemSmsTemplatesParam = any;
830
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
@@ -176,6 +160,15 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
176
160
  * @property {number} [pageNo] - Current page no
177
161
  * @property {number} [pageSize] - Current request items count
178
162
  * @property {string} [populate] - Populate Fields
163
+ * @property {string} [group] - An event group is a collection of email and SMS
164
+ * templates. Filtering by event group lets you view or manage all related
165
+ * communication templates together.
166
+ * @property {string} [subGroup] - Filter by event subgroup. Here, a subgroup is
167
+ * a subset within a group, containing specific email and SMS templates for
168
+ * more detailed organization.
169
+ * @property {string} [fulfillmentOptionSlug] - Filter by fulfillment option
170
+ * slug. Indicates the delivery choice selected, e.g., standard-delivery or
171
+ * homedelivery.
179
172
  */
180
173
 
181
174
  /**
@@ -258,8 +251,6 @@ const CommunicationPlatformModel = require("./CommunicationPlatformModel");
258
251
  * @property {Object} [query] - To search based on plain text
259
252
  */
260
253
 
261
- /** @typedef GetSystemAudiencesParam */
262
-
263
254
  /** @typedef GetSystemEmailTemplatesParam */
264
255
 
265
256
  /** @typedef GetSystemSmsTemplatesParam */
@@ -345,21 +336,6 @@ class CommunicationPlatformApplicationValidator {
345
336
  }).required();
346
337
  }
347
338
 
348
- /** @returns {CreateBigQueryHeadersParam} */
349
- static createBigQueryHeaders() {
350
- return Joi.object({}).required();
351
- }
352
-
353
- /** @returns {CreateBigQueryNCountParam} */
354
- static createBigQueryNCount() {
355
- return Joi.object({}).required();
356
- }
357
-
358
- /** @returns {CreateBigQueryRowCountParam} */
359
- static createBigQueryRowCount() {
360
- return Joi.object({}).required();
361
- }
362
-
363
339
  /** @returns {CreateCampaignParam} */
364
340
  static createCampaign() {
365
341
  return Joi.object({
@@ -489,20 +465,6 @@ class CommunicationPlatformApplicationValidator {
489
465
  }).required();
490
466
  }
491
467
 
492
- /** @returns {GetBigQueryHeadersByIdParam} */
493
- static getBigQueryHeadersById() {
494
- return Joi.object({
495
- id: Joi.string().allow("").required(),
496
- }).required();
497
- }
498
-
499
- /** @returns {GetBigQueryRowCountByIdParam} */
500
- static getBigQueryRowCountById() {
501
- return Joi.object({
502
- id: Joi.string().allow("").required(),
503
- }).required();
504
- }
505
-
506
468
  /** @returns {GetCampaignByIdParam} */
507
469
  static getCampaignById() {
508
470
  return Joi.object({
@@ -587,6 +549,9 @@ class CommunicationPlatformApplicationValidator {
587
549
  pageNo: Joi.number(),
588
550
  pageSize: Joi.number(),
589
551
  populate: Joi.string().allow(""),
552
+ group: Joi.string().allow(""),
553
+ subGroup: Joi.string().allow(""),
554
+ fulfillmentOptionSlug: Joi.string().allow(""),
590
555
  }).required();
591
556
  }
592
557
 
@@ -704,11 +669,6 @@ class CommunicationPlatformApplicationValidator {
704
669
  }).required();
705
670
  }
706
671
 
707
- /** @returns {GetSystemAudiencesParam} */
708
- static getSystemAudiences() {
709
- return Joi.object({}).required();
710
- }
711
-
712
672
  /** @returns {GetSystemEmailTemplatesParam} */
713
673
  static getSystemEmailTemplates() {
714
674
  return Joi.object({}).required();
@@ -1,4 +1,20 @@
1
1
  export = CommunicationPlatformModel;
2
+ /**
3
+ * @typedef GroupMapping
4
+ * @property {EventGroup[]} items - List of event groups configured for the application.
5
+ */
6
+ /**
7
+ * @typedef EventGroup
8
+ * @property {string} name - Event group identifier
9
+ * @property {string} display - Human-readable group name
10
+ * @property {EventSubgroup[]} subgroups - List of sub-groups that belong to
11
+ * this event group.
12
+ */
13
+ /**
14
+ * @typedef EventSubgroup
15
+ * @property {string} name - Sub-group identifier
16
+ * @property {string} display - Human-readable sub-group name
17
+ */
2
18
  /**
3
19
  * @typedef EventSubscriptionsBulkUpdatePayload
4
20
  * @property {SubscriptionsObject[]} [subscriptions]
@@ -884,8 +900,45 @@ export = CommunicationPlatformModel;
884
900
  declare class CommunicationPlatformModel {
885
901
  }
886
902
  declare namespace CommunicationPlatformModel {
887
- export { EventSubscriptionsBulkUpdatePayload, EventSubscriptionsBulkUpdateResult, SubscriptionsObject, TemplateObject, CommunicationTemplate, AppProvider, AppProviderRes, AppProviderResVoice, AppProviderResObj, GlobalProviders, GlobalProvidersResObj, AppProviderReq, StatsImported, StatsProcessedEmail, StatsProcessedSms, StatsProcessed, Stats, GetStats, CampaignReq, RecipientHeaders, CampaignEmailTemplate, CampignEmailProvider, CampaignEmail, Campaign, Campaigns, BadRequestSchema, NotFound, AudienceReq, Audience, Audiences, GetNRecordsCsvReq, GetNRecordsCsvResItems, GetNRecordsCsvRes, DummyDatasources, DummyDatasourcesMeta, DummyDatasourcesMetaObj, EmailProviderReqFrom, EmailProviderReq, EmailProvider, EmailProviders, EmailTemplateKeys, EmailTemplateHeaders, EmailTemplateReq, TemplateAndType, EmailTemplate, SystemEmailTemplate, EmailTemplates, SystemEmailTemplates, PayloadEmailTemplateStructure, PayloadEmailProviderStructure, PayloadEmailStructure, PayloadSmsTemplateStructure, PayloadSmsProviderStructure, PayloadSmsStructure, PayloadStructure, MetaStructure, EnginePayload, EngineResult, EventSubscriptionTemplateSms, EventSubscriptionTemplateEmail, EventSubscriptionTemplate, EventSubscription, EventSubscriptionEvents, EventTemplate, EventProviderTemplates, EventSubscriptions, TriggerJobResult, TriggerJobPayload, GetGlobalVariablesResult, CreateGlobalVariablesResult, GlobalVariablesReq, Job, Jobs, CreateJobsRes, CreateJobsReq, JobLog, JobLogs, LogEmail, LogPushnotification, LogMeta, Log, Logs, SendOtpSmsCommsTemplate, SendOtpSmsCommsProvider, SendOtpEmailCommsProvider, SendOtpEmailCommsTemplate, SendOtpCommsReqData, SendOtpCommsReqSms, SendOtpCommsReqEmail, SendOtpCommsResSms, SendOtpCommsResEmail, SendOtpCommsReq, SendOtpCommsRes, VerifyOtpCommsReq, VerifyOtpCommsSuccessRes, VerifyOtpCommsErrorRes, SmsProviderReq, SmsProvider, SmsProviders, DefaultSmsProviders, SmsTemplateMessage, SmsTemplates, SmsTemplate, SystemSmsTemplates, SystemSmsTemplate, metaObj, SmsTemplateReq, Notification, SystemNotificationUser, SystemNotification, SystemNotifications, Page, GenericError, GenericDelete, Message, EnabledObj, OtpConfigurationExpiryDuration, OtpConfigurationExpiry, OtpConfiguration };
903
+ export { GroupMapping, EventGroup, EventSubgroup, EventSubscriptionsBulkUpdatePayload, EventSubscriptionsBulkUpdateResult, SubscriptionsObject, TemplateObject, CommunicationTemplate, AppProvider, AppProviderRes, AppProviderResVoice, AppProviderResObj, GlobalProviders, GlobalProvidersResObj, AppProviderReq, StatsImported, StatsProcessedEmail, StatsProcessedSms, StatsProcessed, Stats, GetStats, CampaignReq, RecipientHeaders, CampaignEmailTemplate, CampignEmailProvider, CampaignEmail, Campaign, Campaigns, BadRequestSchema, NotFound, AudienceReq, Audience, Audiences, GetNRecordsCsvReq, GetNRecordsCsvResItems, GetNRecordsCsvRes, DummyDatasources, DummyDatasourcesMeta, DummyDatasourcesMetaObj, EmailProviderReqFrom, EmailProviderReq, EmailProvider, EmailProviders, EmailTemplateKeys, EmailTemplateHeaders, EmailTemplateReq, TemplateAndType, EmailTemplate, SystemEmailTemplate, EmailTemplates, SystemEmailTemplates, PayloadEmailTemplateStructure, PayloadEmailProviderStructure, PayloadEmailStructure, PayloadSmsTemplateStructure, PayloadSmsProviderStructure, PayloadSmsStructure, PayloadStructure, MetaStructure, EnginePayload, EngineResult, EventSubscriptionTemplateSms, EventSubscriptionTemplateEmail, EventSubscriptionTemplate, EventSubscription, EventSubscriptionEvents, EventTemplate, EventProviderTemplates, EventSubscriptions, TriggerJobResult, TriggerJobPayload, GetGlobalVariablesResult, CreateGlobalVariablesResult, GlobalVariablesReq, Job, Jobs, CreateJobsRes, CreateJobsReq, JobLog, JobLogs, LogEmail, LogPushnotification, LogMeta, Log, Logs, SendOtpSmsCommsTemplate, SendOtpSmsCommsProvider, SendOtpEmailCommsProvider, SendOtpEmailCommsTemplate, SendOtpCommsReqData, SendOtpCommsReqSms, SendOtpCommsReqEmail, SendOtpCommsResSms, SendOtpCommsResEmail, SendOtpCommsReq, SendOtpCommsRes, VerifyOtpCommsReq, VerifyOtpCommsSuccessRes, VerifyOtpCommsErrorRes, SmsProviderReq, SmsProvider, SmsProviders, DefaultSmsProviders, SmsTemplateMessage, SmsTemplates, SmsTemplate, SystemSmsTemplates, SystemSmsTemplate, metaObj, SmsTemplateReq, Notification, SystemNotificationUser, SystemNotification, SystemNotifications, Page, GenericError, GenericDelete, Message, EnabledObj, OtpConfigurationExpiryDuration, OtpConfigurationExpiry, OtpConfiguration };
888
904
  }
905
+ /** @returns {GroupMapping} */
906
+ declare function GroupMapping(): GroupMapping;
907
+ type GroupMapping = {
908
+ /**
909
+ * - List of event groups configured for the application.
910
+ */
911
+ items: EventGroup[];
912
+ };
913
+ /** @returns {EventGroup} */
914
+ declare function EventGroup(): EventGroup;
915
+ type EventGroup = {
916
+ /**
917
+ * - Event group identifier
918
+ */
919
+ name: string;
920
+ /**
921
+ * - Human-readable group name
922
+ */
923
+ display: string;
924
+ /**
925
+ * - List of sub-groups that belong to
926
+ * this event group.
927
+ */
928
+ subgroups: EventSubgroup[];
929
+ };
930
+ /** @returns {EventSubgroup} */
931
+ declare function EventSubgroup(): EventSubgroup;
932
+ type EventSubgroup = {
933
+ /**
934
+ * - Sub-group identifier
935
+ */
936
+ name: string;
937
+ /**
938
+ * - Human-readable sub-group name
939
+ */
940
+ display: string;
941
+ };
889
942
  /** @returns {EventSubscriptionsBulkUpdatePayload} */
890
943
  declare function EventSubscriptionsBulkUpdatePayload(): EventSubscriptionsBulkUpdatePayload;
891
944
  type EventSubscriptionsBulkUpdatePayload = {
@@ -1,5 +1,24 @@
1
1
  const Joi = require("joi");
2
2
 
3
+ /**
4
+ * @typedef GroupMapping
5
+ * @property {EventGroup[]} items - List of event groups configured for the application.
6
+ */
7
+
8
+ /**
9
+ * @typedef EventGroup
10
+ * @property {string} name - Event group identifier
11
+ * @property {string} display - Human-readable group name
12
+ * @property {EventSubgroup[]} subgroups - List of sub-groups that belong to
13
+ * this event group.
14
+ */
15
+
16
+ /**
17
+ * @typedef EventSubgroup
18
+ * @property {string} name - Sub-group identifier
19
+ * @property {string} display - Human-readable sub-group name
20
+ */
21
+
3
22
  /**
4
23
  * @typedef EventSubscriptionsBulkUpdatePayload
5
24
  * @property {SubscriptionsObject[]} [subscriptions]
@@ -1002,6 +1021,34 @@ const Joi = require("joi");
1002
1021
  */
1003
1022
 
1004
1023
  class CommunicationPlatformModel {
1024
+ /** @returns {GroupMapping} */
1025
+ static GroupMapping() {
1026
+ return Joi.object({
1027
+ items: Joi.array()
1028
+ .items(CommunicationPlatformModel.EventGroup())
1029
+ .required(),
1030
+ });
1031
+ }
1032
+
1033
+ /** @returns {EventGroup} */
1034
+ static EventGroup() {
1035
+ return Joi.object({
1036
+ name: Joi.string().allow("").required(),
1037
+ display: Joi.string().allow("").required(),
1038
+ subgroups: Joi.array()
1039
+ .items(CommunicationPlatformModel.EventSubgroup())
1040
+ .required(),
1041
+ });
1042
+ }
1043
+
1044
+ /** @returns {EventSubgroup} */
1045
+ static EventSubgroup() {
1046
+ return Joi.object({
1047
+ name: Joi.string().allow("").required(),
1048
+ display: Joi.string().allow("").required(),
1049
+ });
1050
+ }
1051
+
1005
1052
  /** @returns {EventSubscriptionsBulkUpdatePayload} */
1006
1053
  static EventSubscriptionsBulkUpdatePayload() {
1007
1054
  return Joi.object({
@@ -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
  }
@@ -757,7 +757,7 @@ declare class Content {
757
757
  * @summary: Get all HTML tags
758
758
  * @description: Retrieve a list of injectable tags. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/getInjectableTags/).
759
759
  */
760
- getInjectableTags({ all, pageNo, pageSize, search, requestHeaders }?: ContentPlatformApplicationValidator.GetInjectableTagsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.TagsSchema>;
760
+ getInjectableTags({ all, search, requestHeaders }?: ContentPlatformApplicationValidator.GetInjectableTagsParam, { responseHeaders }?: object): Promise<ContentPlatformModel.TagsSchema>;
761
761
  /**
762
762
  * @param {ContentPlatformApplicationValidator.GetLandingPagesParam} arg - Arg object
763
763
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -5207,7 +5207,7 @@ class Content {
5207
5207
  * @description: Retrieve a list of injectable tags. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/content/getInjectableTags/).
5208
5208
  */
5209
5209
  async getInjectableTags(
5210
- { all, pageNo, pageSize, search, requestHeaders } = { requestHeaders: {} },
5210
+ { all, search, requestHeaders } = { requestHeaders: {} },
5211
5211
  { responseHeaders } = { responseHeaders: false }
5212
5212
  ) {
5213
5213
  const {
@@ -5215,8 +5215,6 @@ class Content {
5215
5215
  } = ContentPlatformApplicationValidator.getInjectableTags().validate(
5216
5216
  {
5217
5217
  all,
5218
- pageNo,
5219
- pageSize,
5220
5218
  search,
5221
5219
  },
5222
5220
  { abortEarly: false, allowUnknown: true }
@@ -5231,8 +5229,6 @@ class Content {
5231
5229
  } = ContentPlatformApplicationValidator.getInjectableTags().validate(
5232
5230
  {
5233
5231
  all,
5234
- pageNo,
5235
- pageSize,
5236
5232
  search,
5237
5233
  },
5238
5234
  { abortEarly: false, allowUnknown: false }
@@ -5246,8 +5242,6 @@ class Content {
5246
5242
 
5247
5243
  const query_params = {};
5248
5244
  query_params["all"] = all;
5249
- query_params["page_no"] = pageNo;
5250
- query_params["page_size"] = pageSize;
5251
5245
  query_params["search"] = search;
5252
5246
 
5253
5247
  const response = await PlatformAPIClient.execute(
@@ -294,10 +294,6 @@ export = ContentPlatformApplicationValidator;
294
294
  /**
295
295
  * @typedef GetInjectableTagsParam
296
296
  * @property {boolean} [all] - Get all tags irrespective of the creator of tags
297
- * @property {number} [pageNo] - The page number to navigate through the given
298
- * set of results. Default value is 1.
299
- * @property {number} [pageSize] - The number of items to retrieve in each page.
300
- * Default value is 10.
301
297
  * @property {string} [search] - Keyword to filter and find tags by name.
302
298
  */
303
299
  /**
@@ -1061,16 +1057,6 @@ type GetInjectableTagsParam = {
1061
1057
  * - Get all tags irrespective of the creator of tags
1062
1058
  */
1063
1059
  all?: boolean;
1064
- /**
1065
- * - The page number to navigate through the given
1066
- * set of results. Default value is 1.
1067
- */
1068
- pageNo?: number;
1069
- /**
1070
- * - The number of items to retrieve in each page.
1071
- * Default value is 10.
1072
- */
1073
- pageSize?: number;
1074
1060
  /**
1075
1061
  * - Keyword to filter and find tags by name.
1076
1062
  */
@@ -360,10 +360,6 @@ const ContentPlatformModel = require("./ContentPlatformModel");
360
360
  /**
361
361
  * @typedef GetInjectableTagsParam
362
362
  * @property {boolean} [all] - Get all tags irrespective of the creator of tags
363
- * @property {number} [pageNo] - The page number to navigate through the given
364
- * set of results. Default value is 1.
365
- * @property {number} [pageSize] - The number of items to retrieve in each page.
366
- * Default value is 10.
367
363
  * @property {string} [search] - Keyword to filter and find tags by name.
368
364
  */
369
365
 
@@ -1097,8 +1093,6 @@ class ContentPlatformApplicationValidator {
1097
1093
  static getInjectableTags() {
1098
1094
  return Joi.object({
1099
1095
  all: Joi.boolean(),
1100
- pageNo: Joi.number(),
1101
- pageSize: Joi.number(),
1102
1096
  search: Joi.string().allow(""),
1103
1097
  }).required();
1104
1098
  }
@@ -774,7 +774,6 @@ export = ContentPlatformModel;
774
774
  * @property {string} [company] - The ID of the company associated with this tags.
775
775
  * @property {TagSchema[]} [tags] - A list of tags (HTML resources like scripts
776
776
  * or stylesheets) that are configured for the application.
777
- * @property {Page} [page]
778
777
  */
779
778
  /**
780
779
  * @typedef TagSchema
@@ -2710,7 +2709,6 @@ type TagsSchema = {
2710
2709
  * or stylesheets) that are configured for the application.
2711
2710
  */
2712
2711
  tags?: TagSchema[];
2713
- page?: Page;
2714
2712
  };
2715
2713
  /** @returns {TagSchema} */
2716
2714
  declare function TagSchema(): TagSchema;
@@ -876,7 +876,6 @@ const Joi = require("joi");
876
876
  * @property {string} [company] - The ID of the company associated with this tags.
877
877
  * @property {TagSchema[]} [tags] - A list of tags (HTML resources like scripts
878
878
  * or stylesheets) that are configured for the application.
879
- * @property {Page} [page]
880
879
  */
881
880
 
882
881
  /**
@@ -2871,7 +2870,6 @@ class ContentPlatformModel {
2871
2870
  _id: Joi.string().allow(""),
2872
2871
  company: Joi.string().allow(""),
2873
2872
  tags: Joi.array().items(ContentPlatformModel.TagSchema()),
2874
- page: ContentPlatformModel.Page(),
2875
2873
  });
2876
2874
  }
2877
2875