@gofynd/fdk-client-javascript 1.4.15 → 1.4.16-beta.2

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 (95) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +16 -16
  4. package/sdk/application/Cart/CartApplicationClient.js +101 -48
  5. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +16 -16
  6. package/sdk/application/Catalog/CatalogApplicationClient.js +159 -0
  7. package/sdk/application/Common/CommonApplicationClient.js +6 -0
  8. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -0
  9. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +2 -2
  10. package/sdk/application/Configuration/ConfigurationApplicationClient.js +24 -0
  11. package/sdk/application/Content/ContentApplicationClient.d.ts +59 -7
  12. package/sdk/application/Content/ContentApplicationClient.js +290 -0
  13. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
  14. package/sdk/application/FileStorage/FileStorageApplicationClient.js +24 -0
  15. package/sdk/application/Finance/FinanceApplicationClient.js +6 -0
  16. package/sdk/application/Lead/LeadApplicationClient.d.ts +4 -4
  17. package/sdk/application/Lead/LeadApplicationClient.js +42 -0
  18. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +6 -6
  19. package/sdk/application/Logistic/LogisticApplicationClient.js +69 -2
  20. package/sdk/application/Order/OrderApplicationClient.d.ts +11 -11
  21. package/sdk/application/Order/OrderApplicationClient.js +117 -0
  22. package/sdk/application/Payment/PaymentApplicationClient.d.ts +1 -11
  23. package/sdk/application/Payment/PaymentApplicationClient.js +15 -39
  24. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +1 -1
  25. package/sdk/application/Rewards/RewardsApplicationClient.js +15 -0
  26. package/sdk/application/Share/ShareApplicationClient.d.ts +4 -4
  27. package/sdk/application/Share/ShareApplicationClient.js +42 -0
  28. package/sdk/application/Theme/ThemeApplicationClient.d.ts +3 -3
  29. package/sdk/application/Theme/ThemeApplicationClient.js +36 -0
  30. package/sdk/application/User/UserApplicationClient.js +6 -0
  31. package/sdk/application/Webhook/WebhookApplicationClient.js +6 -0
  32. package/sdk/common/Utility.d.ts +1 -1
  33. package/sdk/common/Utility.js +4 -4
  34. package/sdk/common/Validator.d.ts +1 -0
  35. package/sdk/common/Validator.js +20 -0
  36. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +12 -33
  37. package/sdk/partner/Logistics/LogisticsPartnerClient.js +38 -209
  38. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +19 -399
  39. package/sdk/partner/Logistics/LogisticsPartnerModel.js +11 -212
  40. package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -3
  41. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +7 -22
  42. package/sdk/partner/OAuthClient.js +1 -0
  43. package/sdk/partner/Theme/ThemePartnerModel.d.ts +3 -40
  44. package/sdk/partner/Theme/ThemePartnerModel.js +2 -24
  45. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
  46. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +1 -1
  47. package/sdk/platform/Cart/CartPlatformApplicationClient.js +12 -3
  48. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +11 -1
  49. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +4 -1
  50. package/sdk/platform/Cart/CartPlatformModel.d.ts +49 -28
  51. package/sdk/platform/Cart/CartPlatformModel.js +23 -13
  52. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +0 -24
  53. package/sdk/platform/Catalog/CatalogPlatformClient.js +0 -176
  54. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +33 -80
  55. package/sdk/platform/Catalog/CatalogPlatformModel.js +36 -72
  56. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1 -45
  57. package/sdk/platform/Catalog/CatalogPlatformValidator.js +0 -35
  58. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +7 -0
  59. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +3 -0
  60. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +132 -0
  61. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1104 -122
  62. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +159 -1
  63. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +161 -0
  64. package/sdk/platform/Content/ContentPlatformModel.d.ts +220 -5
  65. package/sdk/platform/Content/ContentPlatformModel.js +214 -4
  66. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +0 -10
  67. package/sdk/platform/Order/OrderPlatformApplicationClient.js +0 -92
  68. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -28
  69. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -18
  70. package/sdk/platform/Order/OrderPlatformClient.d.ts +12 -2
  71. package/sdk/platform/Order/OrderPlatformClient.js +99 -8
  72. package/sdk/platform/Order/OrderPlatformModel.d.ts +3 -75
  73. package/sdk/platform/Order/OrderPlatformModel.js +2 -43
  74. package/sdk/platform/Order/OrderPlatformValidator.d.ts +33 -23
  75. package/sdk/platform/Order/OrderPlatformValidator.js +20 -10
  76. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +1 -95
  77. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +78 -701
  78. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +23 -598
  79. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +20 -382
  80. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +3 -136
  81. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -110
  82. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +3 -3
  83. package/sdk/platform/Share/SharePlatformApplicationClient.js +7 -7
  84. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +3 -6
  85. package/sdk/platform/Share/SharePlatformApplicationValidator.js +2 -2
  86. package/sdk/platform/Share/SharePlatformModel.d.ts +10 -2
  87. package/sdk/platform/Share/SharePlatformModel.js +4 -2
  88. package/sdk/platform/Theme/ThemePlatformModel.d.ts +3 -40
  89. package/sdk/platform/Theme/ThemePlatformModel.js +2 -24
  90. package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -0
  91. package/sdk/public/Content/ContentPublicClient.d.ts +3 -3
  92. package/sdk/public/Content/ContentPublicClient.js +28 -0
  93. package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
  94. package/sdk/public/Partner/PartnerPublicClient.js +10 -0
  95. package/sdk/public/Webhook/WebhookPublicClient.js +1 -0
@@ -15,10 +15,6 @@ export = ServiceabilityPlatformValidator;
15
15
  * @typedef CreateCourierPartnerAccountParam
16
16
  * @property {ServiceabilityPlatformModel.CourierAccountDetailsBody} body
17
17
  */
18
- /**
19
- * @typedef CreateCourierPartnerSchemeParam
20
- * @property {ServiceabilityPlatformModel.CourierPartnerSchemeV2DetailsModel} body
21
- */
22
18
  /**
23
19
  * @typedef CreatePackageMaterialParam
24
20
  * @property {ServiceabilityPlatformModel.PackageMaterial} body
@@ -61,15 +57,6 @@ export = ServiceabilityPlatformValidator;
61
57
  * @property {string} [endDate] - Fetch job history before a particule date
62
58
  */
63
59
  /** @typedef GetCompanyConfigurationParam */
64
- /**
65
- * @typedef GetCountriesParam
66
- * @property {boolean} [onboarding] - Only fetch countries which allowed for
67
- * onboard on Platform.
68
- * @property {number} [pageNo] - Page number.
69
- * @property {number} [pageSize] - Page size.
70
- * @property {string} [q] - Search.
71
- * @property {string} [hierarchy] - Fetch countries that has certain heirarchy present.
72
- */
73
60
  /**
74
61
  * @typedef GetCourierPartnerAccountParam
75
62
  * @property {string} accountId - Unique ID of courier partner account
@@ -82,20 +69,6 @@ export = ServiceabilityPlatformValidator;
82
69
  * @property {string} [paymentMode] - Filters dp accounts based on payment mode
83
70
  * @property {string} [transportType] - Filters dp accounts based on transport_type
84
71
  */
85
- /**
86
- * @typedef GetCourierPartnerSchemeParam
87
- * @property {string} schemeId - Unique Identifier of Scheme
88
- */
89
- /**
90
- * @typedef GetCourierPartnerSchemesParam
91
- * @property {string} [schemeType] - Indicates whether a scheme is created by an
92
- * admin for global purposes or customized for a specific company.
93
- * @property {string} [paymentMode] - Indicates payment mode for a scheme.
94
- * @property {string[]} [capabilities] - Indicates whether the scheme possesses
95
- * certain capabilities.
96
- * @property {string[]} [schemeIds] - List of scheme ids which need to be
97
- * returned in the response.
98
- */
99
72
  /**
100
73
  * @typedef GetOptimalLocationsParam
101
74
  * @property {ServiceabilityPlatformModel.OptimlLocationsDetailsSchema} body
@@ -123,12 +96,6 @@ export = ServiceabilityPlatformValidator;
123
96
  * @typedef GetPackageMaterialsParam
124
97
  * @property {string} packageMaterialId - Unique identifier for a Package. Material
125
98
  */
126
- /**
127
- * @typedef GetSampleFileServiceabilityStatusParam
128
- * @property {number} [pageNo] - Index of the item to start returning with
129
- * @property {number} [pageSize] - Determines the items to be displayed in a page
130
- * @property {string} [batchId] - Batch id of the execution
131
- */
132
99
  /**
133
100
  * @typedef GetServiceabilityParam
134
101
  * @property {string} extensionId - Unique Identifier of courier partner extension.
@@ -144,7 +111,7 @@ export = ServiceabilityPlatformValidator;
144
111
  * @property {number} [pageNo] - Index of the item to start returning with
145
112
  * @property {number} [pageSize] - Determines the items to be displayed in a page
146
113
  * @property {boolean} [isActive] - Status of Zone (either active or inactive)
147
- * @property {string} [channelId] - Zones filtered by an application
114
+ * @property {string} [applicationId] - Zones filtered by an application
148
115
  * @property {string} [q] - Search with name as a free text
149
116
  * @property {string} [countryIsoCode] - ISO2 code of the country
150
117
  * @property {string} [state] - State name
@@ -152,10 +119,6 @@ export = ServiceabilityPlatformValidator;
152
119
  * @property {string} [pincode] - Pincode value to search zones
153
120
  * @property {string} [sector] - Sector value to search zones
154
121
  */
155
- /**
156
- * @typedef SampleFileServiceabilityParam
157
- * @property {ServiceabilityPlatformModel.BulkRegionServiceabilityTatDetails} body
158
- */
159
122
  /**
160
123
  * @typedef UpdateCompanyConfigurationParam
161
124
  * @property {ServiceabilityPlatformModel.CompanyConfig} body
@@ -165,11 +128,6 @@ export = ServiceabilityPlatformValidator;
165
128
  * @property {string} accountId - Unique ID of courier partner account
166
129
  * @property {ServiceabilityPlatformModel.CourierAccountUpdateDetails} body
167
130
  */
168
- /**
169
- * @typedef UpdateCourierPartnerSchemeParam
170
- * @property {string} schemeId - Unique Identifier of Scheme
171
- * @property {ServiceabilityPlatformModel.CourierPartnerSchemeV2UpdateDetails} body
172
- */
173
131
  /**
174
132
  * @typedef UpdatePackageMaterialRuleParam
175
133
  * @property {string} ruleId - A `package_material_rule_id` is a unique
@@ -200,8 +158,6 @@ declare class ServiceabilityPlatformValidator {
200
158
  static bulkTat(): BulkTatParam;
201
159
  /** @returns {CreateCourierPartnerAccountParam} */
202
160
  static createCourierPartnerAccount(): CreateCourierPartnerAccountParam;
203
- /** @returns {CreateCourierPartnerSchemeParam} */
204
- static createCourierPartnerScheme(): CreateCourierPartnerSchemeParam;
205
161
  /** @returns {CreatePackageMaterialParam} */
206
162
  static createPackageMaterial(): CreatePackageMaterialParam;
207
163
  /** @returns {CreatePackageMaterialRuleParam} */
@@ -216,16 +172,10 @@ declare class ServiceabilityPlatformValidator {
216
172
  static getBulkTat(): GetBulkTatParam;
217
173
  /** @returns {GetCompanyConfigurationParam} */
218
174
  static getCompanyConfiguration(): any;
219
- /** @returns {GetCountriesParam} */
220
- static getCountries(): GetCountriesParam;
221
175
  /** @returns {GetCourierPartnerAccountParam} */
222
176
  static getCourierPartnerAccount(): GetCourierPartnerAccountParam;
223
177
  /** @returns {GetCourierPartnerAccountsParam} */
224
178
  static getCourierPartnerAccounts(): GetCourierPartnerAccountsParam;
225
- /** @returns {GetCourierPartnerSchemeParam} */
226
- static getCourierPartnerScheme(): GetCourierPartnerSchemeParam;
227
- /** @returns {GetCourierPartnerSchemesParam} */
228
- static getCourierPartnerSchemes(): GetCourierPartnerSchemesParam;
229
179
  /** @returns {GetOptimalLocationsParam} */
230
180
  static getOptimalLocations(): GetOptimalLocationsParam;
231
181
  /** @returns {GetPackageMaterialListParam} */
@@ -236,22 +186,16 @@ declare class ServiceabilityPlatformValidator {
236
186
  static getPackageMaterialRules(): GetPackageMaterialRulesParam;
237
187
  /** @returns {GetPackageMaterialsParam} */
238
188
  static getPackageMaterials(): GetPackageMaterialsParam;
239
- /** @returns {GetSampleFileServiceabilityStatusParam} */
240
- static getSampleFileServiceabilityStatus(): GetSampleFileServiceabilityStatusParam;
241
189
  /** @returns {GetServiceabilityParam} */
242
190
  static getServiceability(): GetServiceabilityParam;
243
191
  /** @returns {GetZoneByIdParam} */
244
192
  static getZoneById(): GetZoneByIdParam;
245
193
  /** @returns {GetZonesParam} */
246
194
  static getZones(): GetZonesParam;
247
- /** @returns {SampleFileServiceabilityParam} */
248
- static sampleFileServiceability(): SampleFileServiceabilityParam;
249
195
  /** @returns {UpdateCompanyConfigurationParam} */
250
196
  static updateCompanyConfiguration(): UpdateCompanyConfigurationParam;
251
197
  /** @returns {UpdateCourierPartnerAccountParam} */
252
198
  static updateCourierPartnerAccount(): UpdateCourierPartnerAccountParam;
253
- /** @returns {UpdateCourierPartnerSchemeParam} */
254
- static updateCourierPartnerScheme(): UpdateCourierPartnerSchemeParam;
255
199
  /** @returns {UpdatePackageMaterialRuleParam} */
256
200
  static updatePackageMaterialRule(): UpdatePackageMaterialRuleParam;
257
201
  /** @returns {UpdatePackageMaterialsParam} */
@@ -262,7 +206,7 @@ declare class ServiceabilityPlatformValidator {
262
206
  static updateZoneById(): UpdateZoneByIdParam;
263
207
  }
264
208
  declare namespace ServiceabilityPlatformValidator {
265
- export { BulkServiceabilityParam, BulkTatParam, CreateCourierPartnerAccountParam, CreateCourierPartnerSchemeParam, CreatePackageMaterialParam, CreatePackageMaterialRuleParam, CreateZoneParam, GetAllStoresParam, GetBulkServiceabilityParam, GetBulkTatParam, GetCompanyConfigurationParam, GetCountriesParam, GetCourierPartnerAccountParam, GetCourierPartnerAccountsParam, GetCourierPartnerSchemeParam, GetCourierPartnerSchemesParam, GetOptimalLocationsParam, GetPackageMaterialListParam, GetPackageMaterialRuleParam, GetPackageMaterialRulesParam, GetPackageMaterialsParam, GetSampleFileServiceabilityStatusParam, GetServiceabilityParam, GetZoneByIdParam, GetZonesParam, SampleFileServiceabilityParam, UpdateCompanyConfigurationParam, UpdateCourierPartnerAccountParam, UpdateCourierPartnerSchemeParam, UpdatePackageMaterialRuleParam, UpdatePackageMaterialsParam, UpdateServiceabilityParam, UpdateZoneByIdParam };
209
+ export { BulkServiceabilityParam, BulkTatParam, CreateCourierPartnerAccountParam, CreatePackageMaterialParam, CreatePackageMaterialRuleParam, CreateZoneParam, GetAllStoresParam, GetBulkServiceabilityParam, GetBulkTatParam, GetCompanyConfigurationParam, GetCourierPartnerAccountParam, GetCourierPartnerAccountsParam, GetOptimalLocationsParam, GetPackageMaterialListParam, GetPackageMaterialRuleParam, GetPackageMaterialRulesParam, GetPackageMaterialsParam, GetServiceabilityParam, GetZoneByIdParam, GetZonesParam, UpdateCompanyConfigurationParam, UpdateCourierPartnerAccountParam, UpdatePackageMaterialRuleParam, UpdatePackageMaterialsParam, UpdateServiceabilityParam, UpdateZoneByIdParam };
266
210
  }
267
211
  type BulkServiceabilityParam = {
268
212
  /**
@@ -289,9 +233,6 @@ type BulkTatParam = {
289
233
  type CreateCourierPartnerAccountParam = {
290
234
  body: ServiceabilityPlatformModel.CourierAccountDetailsBody;
291
235
  };
292
- type CreateCourierPartnerSchemeParam = {
293
- body: ServiceabilityPlatformModel.CourierPartnerSchemeV2DetailsModel;
294
- };
295
236
  type CreatePackageMaterialParam = {
296
237
  body: ServiceabilityPlatformModel.PackageMaterial;
297
238
  };
@@ -393,29 +334,6 @@ type GetBulkTatParam = {
393
334
  */
394
335
  endDate?: string;
395
336
  };
396
- type GetCountriesParam = {
397
- /**
398
- * - Only fetch countries which allowed for
399
- * onboard on Platform.
400
- */
401
- onboarding?: boolean;
402
- /**
403
- * - Page number.
404
- */
405
- pageNo?: number;
406
- /**
407
- * - Page size.
408
- */
409
- pageSize?: number;
410
- /**
411
- * - Search.
412
- */
413
- q?: string;
414
- /**
415
- * - Fetch countries that has certain heirarchy present.
416
- */
417
- hierarchy?: string;
418
- };
419
337
  type GetCourierPartnerAccountParam = {
420
338
  /**
421
339
  * - Unique ID of courier partner account
@@ -444,33 +362,6 @@ type GetCourierPartnerAccountsParam = {
444
362
  */
445
363
  transportType?: string;
446
364
  };
447
- type GetCourierPartnerSchemeParam = {
448
- /**
449
- * - Unique Identifier of Scheme
450
- */
451
- schemeId: string;
452
- };
453
- type GetCourierPartnerSchemesParam = {
454
- /**
455
- * - Indicates whether a scheme is created by an
456
- * admin for global purposes or customized for a specific company.
457
- */
458
- schemeType?: string;
459
- /**
460
- * - Indicates payment mode for a scheme.
461
- */
462
- paymentMode?: string;
463
- /**
464
- * - Indicates whether the scheme possesses
465
- * certain capabilities.
466
- */
467
- capabilities?: string[];
468
- /**
469
- * - List of scheme ids which need to be
470
- * returned in the response.
471
- */
472
- schemeIds?: string[];
473
- };
474
365
  type GetOptimalLocationsParam = {
475
366
  body: ServiceabilityPlatformModel.OptimlLocationsDetailsSchema;
476
367
  };
@@ -523,20 +414,6 @@ type GetPackageMaterialsParam = {
523
414
  */
524
415
  packageMaterialId: string;
525
416
  };
526
- type GetSampleFileServiceabilityStatusParam = {
527
- /**
528
- * - Index of the item to start returning with
529
- */
530
- pageNo?: number;
531
- /**
532
- * - Determines the items to be displayed in a page
533
- */
534
- pageSize?: number;
535
- /**
536
- * - Batch id of the execution
537
- */
538
- batchId?: string;
539
- };
540
417
  type GetServiceabilityParam = {
541
418
  /**
542
419
  * - Unique Identifier of courier partner extension.
@@ -573,7 +450,7 @@ type GetZonesParam = {
573
450
  /**
574
451
  * - Zones filtered by an application
575
452
  */
576
- channelId?: string;
453
+ applicationId?: string;
577
454
  /**
578
455
  * - Search with name as a free text
579
456
  */
@@ -599,9 +476,6 @@ type GetZonesParam = {
599
476
  */
600
477
  sector?: string;
601
478
  };
602
- type SampleFileServiceabilityParam = {
603
- body: ServiceabilityPlatformModel.BulkRegionServiceabilityTatDetails;
604
- };
605
479
  type UpdateCompanyConfigurationParam = {
606
480
  body: ServiceabilityPlatformModel.CompanyConfig;
607
481
  };
@@ -612,13 +486,6 @@ type UpdateCourierPartnerAccountParam = {
612
486
  accountId: string;
613
487
  body: ServiceabilityPlatformModel.CourierAccountUpdateDetails;
614
488
  };
615
- type UpdateCourierPartnerSchemeParam = {
616
- /**
617
- * - Unique Identifier of Scheme
618
- */
619
- schemeId: string;
620
- body: ServiceabilityPlatformModel.CourierPartnerSchemeV2UpdateDetails;
621
- };
622
489
  type UpdatePackageMaterialRuleParam = {
623
490
  /**
624
491
  * - A `package_material_rule_id` is a unique
@@ -21,11 +21,6 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
21
21
  * @property {ServiceabilityPlatformModel.CourierAccountDetailsBody} body
22
22
  */
23
23
 
24
- /**
25
- * @typedef CreateCourierPartnerSchemeParam
26
- * @property {ServiceabilityPlatformModel.CourierPartnerSchemeV2DetailsModel} body
27
- */
28
-
29
24
  /**
30
25
  * @typedef CreatePackageMaterialParam
31
26
  * @property {ServiceabilityPlatformModel.PackageMaterial} body
@@ -75,16 +70,6 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
75
70
 
76
71
  /** @typedef GetCompanyConfigurationParam */
77
72
 
78
- /**
79
- * @typedef GetCountriesParam
80
- * @property {boolean} [onboarding] - Only fetch countries which allowed for
81
- * onboard on Platform.
82
- * @property {number} [pageNo] - Page number.
83
- * @property {number} [pageSize] - Page size.
84
- * @property {string} [q] - Search.
85
- * @property {string} [hierarchy] - Fetch countries that has certain heirarchy present.
86
- */
87
-
88
73
  /**
89
74
  * @typedef GetCourierPartnerAccountParam
90
75
  * @property {string} accountId - Unique ID of courier partner account
@@ -99,22 +84,6 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
99
84
  * @property {string} [transportType] - Filters dp accounts based on transport_type
100
85
  */
101
86
 
102
- /**
103
- * @typedef GetCourierPartnerSchemeParam
104
- * @property {string} schemeId - Unique Identifier of Scheme
105
- */
106
-
107
- /**
108
- * @typedef GetCourierPartnerSchemesParam
109
- * @property {string} [schemeType] - Indicates whether a scheme is created by an
110
- * admin for global purposes or customized for a specific company.
111
- * @property {string} [paymentMode] - Indicates payment mode for a scheme.
112
- * @property {string[]} [capabilities] - Indicates whether the scheme possesses
113
- * certain capabilities.
114
- * @property {string[]} [schemeIds] - List of scheme ids which need to be
115
- * returned in the response.
116
- */
117
-
118
87
  /**
119
88
  * @typedef GetOptimalLocationsParam
120
89
  * @property {ServiceabilityPlatformModel.OptimlLocationsDetailsSchema} body
@@ -147,13 +116,6 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
147
116
  * @property {string} packageMaterialId - Unique identifier for a Package. Material
148
117
  */
149
118
 
150
- /**
151
- * @typedef GetSampleFileServiceabilityStatusParam
152
- * @property {number} [pageNo] - Index of the item to start returning with
153
- * @property {number} [pageSize] - Determines the items to be displayed in a page
154
- * @property {string} [batchId] - Batch id of the execution
155
- */
156
-
157
119
  /**
158
120
  * @typedef GetServiceabilityParam
159
121
  * @property {string} extensionId - Unique Identifier of courier partner extension.
@@ -171,7 +133,7 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
171
133
  * @property {number} [pageNo] - Index of the item to start returning with
172
134
  * @property {number} [pageSize] - Determines the items to be displayed in a page
173
135
  * @property {boolean} [isActive] - Status of Zone (either active or inactive)
174
- * @property {string} [channelId] - Zones filtered by an application
136
+ * @property {string} [applicationId] - Zones filtered by an application
175
137
  * @property {string} [q] - Search with name as a free text
176
138
  * @property {string} [countryIsoCode] - ISO2 code of the country
177
139
  * @property {string} [state] - State name
@@ -180,11 +142,6 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
180
142
  * @property {string} [sector] - Sector value to search zones
181
143
  */
182
144
 
183
- /**
184
- * @typedef SampleFileServiceabilityParam
185
- * @property {ServiceabilityPlatformModel.BulkRegionServiceabilityTatDetails} body
186
- */
187
-
188
145
  /**
189
146
  * @typedef UpdateCompanyConfigurationParam
190
147
  * @property {ServiceabilityPlatformModel.CompanyConfig} body
@@ -196,12 +153,6 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
196
153
  * @property {ServiceabilityPlatformModel.CourierAccountUpdateDetails} body
197
154
  */
198
155
 
199
- /**
200
- * @typedef UpdateCourierPartnerSchemeParam
201
- * @property {string} schemeId - Unique Identifier of Scheme
202
- * @property {ServiceabilityPlatformModel.CourierPartnerSchemeV2UpdateDetails} body
203
- */
204
-
205
156
  /**
206
157
  * @typedef UpdatePackageMaterialRuleParam
207
158
  * @property {string} ruleId - A `package_material_rule_id` is a unique
@@ -255,13 +206,6 @@ class ServiceabilityPlatformValidator {
255
206
  }).required();
256
207
  }
257
208
 
258
- /** @returns {CreateCourierPartnerSchemeParam} */
259
- static createCourierPartnerScheme() {
260
- return Joi.object({
261
- body: ServiceabilityPlatformModel.CourierPartnerSchemeV2DetailsModel().required(),
262
- }).required();
263
- }
264
-
265
209
  /** @returns {CreatePackageMaterialParam} */
266
210
  static createPackageMaterial() {
267
211
  return Joi.object({
@@ -327,17 +271,6 @@ class ServiceabilityPlatformValidator {
327
271
  return Joi.object({}).required();
328
272
  }
329
273
 
330
- /** @returns {GetCountriesParam} */
331
- static getCountries() {
332
- return Joi.object({
333
- onboarding: Joi.boolean(),
334
- pageNo: Joi.number(),
335
- pageSize: Joi.number(),
336
- q: Joi.string().allow(""),
337
- hierarchy: Joi.string().allow(""),
338
- }).required();
339
- }
340
-
341
274
  /** @returns {GetCourierPartnerAccountParam} */
342
275
  static getCourierPartnerAccount() {
343
276
  return Joi.object({
@@ -356,23 +289,6 @@ class ServiceabilityPlatformValidator {
356
289
  }).required();
357
290
  }
358
291
 
359
- /** @returns {GetCourierPartnerSchemeParam} */
360
- static getCourierPartnerScheme() {
361
- return Joi.object({
362
- schemeId: Joi.string().allow("").required(),
363
- }).required();
364
- }
365
-
366
- /** @returns {GetCourierPartnerSchemesParam} */
367
- static getCourierPartnerSchemes() {
368
- return Joi.object({
369
- schemeType: Joi.string().allow(""),
370
- paymentMode: Joi.string().allow(""),
371
- capabilities: Joi.array().items(Joi.string().allow("")),
372
- schemeIds: Joi.array().items(Joi.string().allow("")),
373
- }).required();
374
- }
375
-
376
292
  /** @returns {GetOptimalLocationsParam} */
377
293
  static getOptimalLocations() {
378
294
  return Joi.object({
@@ -414,15 +330,6 @@ class ServiceabilityPlatformValidator {
414
330
  }).required();
415
331
  }
416
332
 
417
- /** @returns {GetSampleFileServiceabilityStatusParam} */
418
- static getSampleFileServiceabilityStatus() {
419
- return Joi.object({
420
- pageNo: Joi.number(),
421
- pageSize: Joi.number(),
422
- batchId: Joi.string().allow(""),
423
- }).required();
424
- }
425
-
426
333
  /** @returns {GetServiceabilityParam} */
427
334
  static getServiceability() {
428
335
  return Joi.object({
@@ -445,7 +352,7 @@ class ServiceabilityPlatformValidator {
445
352
  pageNo: Joi.number(),
446
353
  pageSize: Joi.number(),
447
354
  isActive: Joi.boolean(),
448
- channelId: Joi.string().allow(""),
355
+ applicationId: Joi.string().allow(""),
449
356
  q: Joi.string().allow(""),
450
357
  countryIsoCode: Joi.string().allow(""),
451
358
  state: Joi.string().allow(""),
@@ -455,13 +362,6 @@ class ServiceabilityPlatformValidator {
455
362
  }).required();
456
363
  }
457
364
 
458
- /** @returns {SampleFileServiceabilityParam} */
459
- static sampleFileServiceability() {
460
- return Joi.object({
461
- body: ServiceabilityPlatformModel.BulkRegionServiceabilityTatDetails().required(),
462
- }).required();
463
- }
464
-
465
365
  /** @returns {UpdateCompanyConfigurationParam} */
466
366
  static updateCompanyConfiguration() {
467
367
  return Joi.object({
@@ -477,14 +377,6 @@ class ServiceabilityPlatformValidator {
477
377
  }).required();
478
378
  }
479
379
 
480
- /** @returns {UpdateCourierPartnerSchemeParam} */
481
- static updateCourierPartnerScheme() {
482
- return Joi.object({
483
- schemeId: Joi.string().allow("").required(),
484
- body: ServiceabilityPlatformModel.CourierPartnerSchemeV2UpdateDetails().required(),
485
- }).required();
486
- }
487
-
488
380
  /** @returns {UpdatePackageMaterialRuleParam} */
489
381
  static updatePackageMaterialRule() {
490
382
  return Joi.object({
@@ -9,7 +9,7 @@ declare class Share {
9
9
  * @param {import("../PlatformAPIClient").Options} - Options
10
10
  * @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
11
11
  * @name createShortLink
12
- * @summary: Create short link
12
+ * @summary: Create short link.
13
13
  * @description: Generate a shortened URL link for sharing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/createShortLink/).
14
14
  */
15
15
  createShortLink({ body, requestHeaders }?: SharePlatformApplicationValidator.CreateShortLinkParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
@@ -19,7 +19,7 @@ declare class Share {
19
19
  * @param {import("../PlatformAPIClient").Options} - Options
20
20
  * @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
21
21
  * @name getShortLinkByHash
22
- * @summary: Get short link by hash
22
+ * @summary: Get short link by hash.
23
23
  * @description: Retrieve a specific short link by its unique hash. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkByHash/).
24
24
  */
25
25
  getShortLinkByHash({ hash, requestHeaders }?: SharePlatformApplicationValidator.GetShortLinkByHashParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
@@ -53,7 +53,7 @@ declare class Share {
53
53
  * @param {import("../PlatformAPIClient").Options} - Options
54
54
  * @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
55
55
  * @name updateShortLinkById
56
- * @summary: Update short link
56
+ * @summary: Update short link by ID.
57
57
  * @description: Update details of a specific short link by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/updateShortLinkById/).
58
58
  */
59
59
  updateShortLinkById({ id, body, requestHeaders }?: SharePlatformApplicationValidator.UpdateShortLinkByIdParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkRes>;
@@ -21,7 +21,7 @@ class Share {
21
21
  * @param {import("../PlatformAPIClient").Options} - Options
22
22
  * @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
23
23
  * @name createShortLink
24
- * @summary: Create short link
24
+ * @summary: Create short link.
25
25
  * @description: Generate a shortened URL link for sharing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/createShortLink/).
26
26
  */
27
27
  async createShortLink(
@@ -61,7 +61,7 @@ class Share {
61
61
  const response = await PlatformAPIClient.execute(
62
62
  this.config,
63
63
  "post",
64
- `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/`,
64
+ `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link`,
65
65
  query_params,
66
66
  body,
67
67
  requestHeaders,
@@ -100,7 +100,7 @@ class Share {
100
100
  * @param {import("../PlatformAPIClient").Options} - Options
101
101
  * @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
102
102
  * @name getShortLinkByHash
103
- * @summary: Get short link by hash
103
+ * @summary: Get short link by hash.
104
104
  * @description: Retrieve a specific short link by its unique hash. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinkByHash/).
105
105
  */
106
106
  async getShortLinkByHash(
@@ -140,7 +140,7 @@ class Share {
140
140
  const response = await PlatformAPIClient.execute(
141
141
  this.config,
142
142
  "get",
143
- `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/${hash}/`,
143
+ `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/${hash}`,
144
144
  query_params,
145
145
  undefined,
146
146
  requestHeaders,
@@ -325,7 +325,7 @@ class Share {
325
325
  const response = await PlatformAPIClient.execute(
326
326
  this.config,
327
327
  "get",
328
- `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/`,
328
+ `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link`,
329
329
  query_params,
330
330
  undefined,
331
331
  requestHeaders,
@@ -366,7 +366,7 @@ class Share {
366
366
  * @param {import("../PlatformAPIClient").Options} - Options
367
367
  * @returns {Promise<SharePlatformModel.ShortLinkRes>} - Success response
368
368
  * @name updateShortLinkById
369
- * @summary: Update short link
369
+ * @summary: Update short link by ID.
370
370
  * @description: Update details of a specific short link by its ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/updateShortLinkById/).
371
371
  */
372
372
  async updateShortLinkById(
@@ -408,7 +408,7 @@ class Share {
408
408
  const response = await PlatformAPIClient.execute(
409
409
  this.config,
410
410
  "patch",
411
- `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/${id}/`,
411
+ `/service/platform/share/v1.0/company/${this.config.companyId}/application/${this.applicationId}/links/short-link/${id}`,
412
412
  query_params,
413
413
  body,
414
414
  requestHeaders,
@@ -5,7 +5,7 @@ export = SharePlatformApplicationValidator;
5
5
  */
6
6
  /**
7
7
  * @typedef GetShortLinkByHashParam
8
- * @property {string} hash - Hash of short url
8
+ * @property {string} hash
9
9
  */
10
10
  /**
11
11
  * @typedef GetShortLinkClickStatsParam
@@ -24,7 +24,7 @@ export = SharePlatformApplicationValidator;
24
24
  */
25
25
  /**
26
26
  * @typedef UpdateShortLinkByIdParam
27
- * @property {string} id - Short link document identifier
27
+ * @property {string} id - Document Id
28
28
  * @property {SharePlatformModel.ShortLinkReq} body
29
29
  */
30
30
  declare class SharePlatformApplicationValidator {
@@ -46,9 +46,6 @@ type CreateShortLinkParam = {
46
46
  body: SharePlatformModel.ShortLinkReq;
47
47
  };
48
48
  type GetShortLinkByHashParam = {
49
- /**
50
- * - Hash of short url
51
- */
52
49
  hash: string;
53
50
  };
54
51
  type GetShortLinkClickStatsParam = {
@@ -90,7 +87,7 @@ type GetShortLinksParam = {
90
87
  };
91
88
  type UpdateShortLinkByIdParam = {
92
89
  /**
93
- * - Short link document identifier
90
+ * - Document Id
94
91
  */
95
92
  id: string;
96
93
  body: SharePlatformModel.ShortLinkReq;
@@ -9,7 +9,7 @@ const SharePlatformModel = require("./SharePlatformModel");
9
9
 
10
10
  /**
11
11
  * @typedef GetShortLinkByHashParam
12
- * @property {string} hash - Hash of short url
12
+ * @property {string} hash
13
13
  */
14
14
 
15
15
  /**
@@ -31,7 +31,7 @@ const SharePlatformModel = require("./SharePlatformModel");
31
31
 
32
32
  /**
33
33
  * @typedef UpdateShortLinkByIdParam
34
- * @property {string} id - Short link document identifier
34
+ * @property {string} id - Document Id
35
35
  * @property {SharePlatformModel.ShortLinkReq} body
36
36
  */
37
37
 
@@ -69,7 +69,6 @@ export = SharePlatformModel;
69
69
  */
70
70
  /**
71
71
  * @typedef UrlInfo
72
- * @property {string} [original]
73
72
  * @property {string} [hash]
74
73
  * @property {string} [short_url]
75
74
  * @property {string} [alias]
@@ -106,6 +105,8 @@ export = SharePlatformModel;
106
105
  * @property {number} [current] - The current page number.
107
106
  * @property {string} type - The type of the page, such as 'PageType'.
108
107
  * @property {number} [size] - The number of items per page.
108
+ * @property {number} [total] - Total number of items.
109
+ * @property {number} [page] - Current page number
109
110
  */
110
111
  /**
111
112
  * @typedef ShortLinkList
@@ -226,7 +227,6 @@ type shortLinkReqMeta = {
226
227
  /** @returns {UrlInfo} */
227
228
  declare function UrlInfo(): UrlInfo;
228
229
  type UrlInfo = {
229
- original?: string;
230
230
  hash?: string;
231
231
  short_url?: string;
232
232
  alias?: string;
@@ -289,6 +289,14 @@ type Page = {
289
289
  * - The number of items per page.
290
290
  */
291
291
  size?: number;
292
+ /**
293
+ * - Total number of items.
294
+ */
295
+ total?: number;
296
+ /**
297
+ * - Current page number
298
+ */
299
+ page?: number;
292
300
  };
293
301
  /** @returns {ShortLinkList} */
294
302
  declare function ShortLinkList(): ShortLinkList;