@gofynd/fdk-client-javascript 1.4.6 → 1.4.7

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 (66) hide show
  1. package/README.md +1 -1
  2. package/package.json +2 -2
  3. package/sdk/application/ApplicationClient.d.ts +2 -0
  4. package/sdk/application/ApplicationClient.js +2 -0
  5. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +6 -0
  6. package/sdk/application/Catalog/CatalogApplicationModel.js +6 -0
  7. package/sdk/application/Content/ContentApplicationModel.d.ts +2 -0
  8. package/sdk/application/Content/ContentApplicationModel.js +2 -0
  9. package/sdk/application/Order/OrderApplicationModel.d.ts +70 -9
  10. package/sdk/application/Order/OrderApplicationModel.js +43 -7
  11. package/sdk/application/Payment/PaymentApplicationModel.d.ts +18 -18
  12. package/sdk/application/Payment/PaymentApplicationModel.js +18 -18
  13. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +22 -0
  14. package/sdk/application/Webhook/WebhookApplicationClient.js +115 -0
  15. package/sdk/application/Webhook/WebhookApplicationModel.d.ts +37 -0
  16. package/sdk/application/Webhook/WebhookApplicationModel.js +46 -0
  17. package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +16 -0
  18. package/sdk/application/Webhook/WebhookApplicationValidator.js +19 -0
  19. package/sdk/application/index.d.ts +1 -0
  20. package/sdk/application/index.js +2 -0
  21. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +2 -2
  22. package/sdk/partner/Webhook/WebhookPartnerClient.js +2 -2
  23. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +23 -19
  24. package/sdk/partner/Webhook/WebhookPartnerModel.js +19 -22
  25. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +43 -0
  26. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +257 -0
  27. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.d.ts +39 -0
  28. package/sdk/platform/Analytics/AnalyticsPlatformApplicationValidator.js +45 -0
  29. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +60 -0
  30. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +57 -0
  31. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +10 -0
  32. package/sdk/platform/Cart/CartPlatformApplicationClient.js +80 -0
  33. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +13 -1
  34. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +12 -0
  35. package/sdk/platform/Cart/CartPlatformModel.d.ts +2 -0
  36. package/sdk/platform/Cart/CartPlatformModel.js +2 -0
  37. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +9 -5
  38. package/sdk/platform/Catalog/CatalogPlatformClient.js +19 -12
  39. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +118 -17
  40. package/sdk/platform/Catalog/CatalogPlatformModel.js +137 -15
  41. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +12 -7
  42. package/sdk/platform/Catalog/CatalogPlatformValidator.js +7 -5
  43. package/sdk/platform/Content/ContentPlatformModel.d.ts +2 -0
  44. package/sdk/platform/Content/ContentPlatformModel.js +2 -0
  45. package/sdk/platform/Order/OrderPlatformClient.d.ts +11 -1
  46. package/sdk/platform/Order/OrderPlatformClient.js +82 -5
  47. package/sdk/platform/Order/OrderPlatformModel.d.ts +163 -15
  48. package/sdk/platform/Order/OrderPlatformModel.js +92 -14
  49. package/sdk/platform/Order/OrderPlatformValidator.d.ts +58 -17
  50. package/sdk/platform/Order/OrderPlatformValidator.js +28 -16
  51. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2 -2
  52. package/sdk/platform/Payment/PaymentPlatformModel.js +2 -2
  53. package/sdk/platform/PlatformApplicationClient.d.ts +2 -0
  54. package/sdk/platform/PlatformApplicationClient.js +4 -0
  55. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +24 -0
  56. package/sdk/platform/Webhook/WebhookPlatformClient.js +164 -0
  57. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +71 -18
  58. package/sdk/platform/Webhook/WebhookPlatformModel.js +75 -22
  59. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +19 -1
  60. package/sdk/platform/Webhook/WebhookPlatformValidator.js +24 -0
  61. package/sdk/platform/index.d.ts +1 -0
  62. package/sdk/platform/index.js +2 -0
  63. package/sdk/public/Webhook/WebhookPublicClient.d.ts +2 -2
  64. package/sdk/public/Webhook/WebhookPublicClient.js +2 -2
  65. package/sdk/public/Webhook/WebhookPublicModel.d.ts +2 -0
  66. package/sdk/public/Webhook/WebhookPublicModel.js +2 -0
@@ -57,8 +57,8 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
57
57
 
58
58
  /**
59
59
  * @typedef CreateMarketplaceOptinParam
60
- * @property {string} marketplace - The marketplace for which the detail needs
61
- * to be retrieved.
60
+ * @property {string} marketplaceSlug - The marketplace for which the detail
61
+ * needs to be retrieved.
62
62
  * @property {CatalogPlatformModel.OptInPostRequest} body
63
63
  */
64
64
 
@@ -228,6 +228,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
228
228
  * set of results
229
229
  * @property {number} [pageSize] - Number of items to retrieve in each page.
230
230
  * Default is 12.
231
+ * @property {string} [search] - Search string to filter the results by batch id
231
232
  */
232
233
 
233
234
  /**
@@ -514,7 +515,7 @@ const CatalogPlatformModel = require("./CatalogPlatformModel");
514
515
  * @property {string} department - Department of the product to be uploaded.
515
516
  * @property {string} productType - Product type of the product to be uploaded
516
517
  * i.e. set, standard , digital.
517
- * @property {CatalogPlatformModel.BulkJob} body
518
+ * @property {CatalogPlatformModel.BulkProductJob} body
518
519
  */
519
520
 
520
521
  /**
@@ -611,7 +612,7 @@ class CatalogPlatformValidator {
611
612
  /** @returns {CreateMarketplaceOptinParam} */
612
613
  static createMarketplaceOptin() {
613
614
  return Joi.object({
614
- marketplace: Joi.string().allow("").required(),
615
+ marketplaceSlug: Joi.string().allow("").required(),
615
616
  body: CatalogPlatformModel.OptInPostRequest().required(),
616
617
  }).required();
617
618
  }
@@ -815,6 +816,7 @@ class CatalogPlatformValidator {
815
816
  return Joi.object({
816
817
  pageNo: Joi.number(),
817
818
  pageSize: Joi.number(),
819
+ search: Joi.string().allow(""),
818
820
  }).required();
819
821
  }
820
822
 
@@ -1149,7 +1151,7 @@ class CatalogPlatformValidator {
1149
1151
  return Joi.object({
1150
1152
  department: Joi.string().allow("").required(),
1151
1153
  productType: Joi.string().allow("").required(),
1152
- body: CatalogPlatformModel.BulkJob().required(),
1154
+ body: CatalogPlatformModel.BulkProductJob().required(),
1153
1155
  }).required();
1154
1156
  }
1155
1157
 
@@ -189,6 +189,7 @@ export = ContentPlatformModel;
189
189
  * @property {boolean} [published]
190
190
  * @property {string} [reading_time]
191
191
  * @property {string} [slug]
192
+ * @property {string} [publish_date]
192
193
  * @property {string[]} [tags]
193
194
  * @property {SEO} [seo]
194
195
  * @property {CronSchedule} [_schedule]
@@ -1446,6 +1447,7 @@ type BlogSchema = {
1446
1447
  published?: boolean;
1447
1448
  reading_time?: string;
1448
1449
  slug?: string;
1450
+ publish_date?: string;
1449
1451
  tags?: string[];
1450
1452
  seo?: SEO;
1451
1453
  _schedule?: CronSchedule;
@@ -215,6 +215,7 @@ const Joi = require("joi");
215
215
  * @property {boolean} [published]
216
216
  * @property {string} [reading_time]
217
217
  * @property {string} [slug]
218
+ * @property {string} [publish_date]
218
219
  * @property {string[]} [tags]
219
220
  * @property {SEO} [seo]
220
221
  * @property {CronSchedule} [_schedule]
@@ -1651,6 +1652,7 @@ class ContentPlatformModel {
1651
1652
  published: Joi.boolean(),
1652
1653
  reading_time: Joi.string().allow(""),
1653
1654
  slug: Joi.string().allow(""),
1655
+ publish_date: Joi.string().allow(""),
1654
1656
  tags: Joi.array().items(Joi.string().allow("")),
1655
1657
  seo: ContentPlatformModel.SEO(),
1656
1658
  _schedule: ContentPlatformModel.CronSchedule(),
@@ -73,7 +73,7 @@ declare class Order {
73
73
  * @summary: Dispatch manifest
74
74
  * @description: Updates the status of the manifest to processed and change the status of the shipments in the manifest to dispatch status - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/dispatchManifests/).
75
75
  */
76
- dispatchManifests({ manifestId, body, requestHeaders }?: OrderPlatformValidator.DispatchManifestsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponse>;
76
+ dispatchManifests({ body, requestHeaders }?: OrderPlatformValidator.DispatchManifestsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.SuccessResponse>;
77
77
  /**
78
78
  * @param {OrderPlatformValidator.DownloadBulkActionTemplateParam} arg - Arg object
79
79
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -159,6 +159,16 @@ declare class Order {
159
159
  * @description: Create a point-of-sale (POS) receipt for a specific order by order Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generatePOSReceiptByOrderId/).
160
160
  */
161
161
  generatePOSReceiptByOrderId({ orderId, shipmentId, documentType, requestHeaders }?: OrderPlatformValidator.GeneratePOSReceiptByOrderIdParam, { responseHeaders }?: object): Promise<OrderPlatformModel.GeneratePosOrderReceiptResponse>;
162
+ /**
163
+ * @param {OrderPlatformValidator.GenerateProcessManifestParam} arg - Arg object
164
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
165
+ * @param {import("../PlatformAPIClient").Options} - Options
166
+ * @returns {Promise<OrderPlatformModel.ManifestResponse>} - Success response
167
+ * @name generateProcessManifest
168
+ * @summary: Process Order Manifest
169
+ * @description: Endpoint to save and process order manifests. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateProcessManifest/).
170
+ */
171
+ generateProcessManifest({ body, requestHeaders }?: OrderPlatformValidator.GenerateProcessManifestParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ManifestResponse>;
162
172
  /**
163
173
  * @param {OrderPlatformValidator.GetAllowedStateTransitionParam} arg - Arg object
164
174
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -524,12 +524,11 @@ class Order {
524
524
  * @description: Updates the status of the manifest to processed and change the status of the shipments in the manifest to dispatch status - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/dispatchManifests/).
525
525
  */
526
526
  async dispatchManifests(
527
- { manifestId, body, requestHeaders } = { requestHeaders: {} },
527
+ { body, requestHeaders } = { requestHeaders: {} },
528
528
  { responseHeaders } = { responseHeaders: false }
529
529
  ) {
530
530
  const { error } = OrderPlatformValidator.dispatchManifests().validate(
531
531
  {
532
- manifestId,
533
532
  body,
534
533
  },
535
534
  { abortEarly: false, allowUnknown: true }
@@ -543,7 +542,6 @@ class Order {
543
542
  error: warrning,
544
543
  } = OrderPlatformValidator.dispatchManifests().validate(
545
544
  {
546
- manifestId,
547
545
  body,
548
546
  },
549
547
  { abortEarly: false, allowUnknown: false }
@@ -562,7 +560,7 @@ class Order {
562
560
  const response = await PlatformAPIClient.execute(
563
561
  this.config,
564
562
  "post",
565
- `/service/platform/order-manage/v1.0/company/${this.config.companyId}/manifest/${manifestId}/dispatch`,
563
+ `/service/platform/order-manage/v1.0/company/${this.config.companyId}/manifest/dispatch`,
566
564
  query_params,
567
565
  body,
568
566
  { ...xHeaders, ...requestHeaders },
@@ -1247,6 +1245,85 @@ class Order {
1247
1245
  return response;
1248
1246
  }
1249
1247
 
1248
+ /**
1249
+ * @param {OrderPlatformValidator.GenerateProcessManifestParam} arg - Arg object
1250
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
1251
+ * @param {import("../PlatformAPIClient").Options} - Options
1252
+ * @returns {Promise<OrderPlatformModel.ManifestResponse>} - Success response
1253
+ * @name generateProcessManifest
1254
+ * @summary: Process Order Manifest
1255
+ * @description: Endpoint to save and process order manifests. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/generateProcessManifest/).
1256
+ */
1257
+ async generateProcessManifest(
1258
+ { body, requestHeaders } = { requestHeaders: {} },
1259
+ { responseHeaders } = { responseHeaders: false }
1260
+ ) {
1261
+ const { error } = OrderPlatformValidator.generateProcessManifest().validate(
1262
+ {
1263
+ body,
1264
+ },
1265
+ { abortEarly: false, allowUnknown: true }
1266
+ );
1267
+ if (error) {
1268
+ return Promise.reject(new FDKClientValidationError(error));
1269
+ }
1270
+
1271
+ // Showing warrnings if extra unknown parameters are found
1272
+ const {
1273
+ error: warrning,
1274
+ } = OrderPlatformValidator.generateProcessManifest().validate(
1275
+ {
1276
+ body,
1277
+ },
1278
+ { abortEarly: false, allowUnknown: false }
1279
+ );
1280
+ if (warrning) {
1281
+ Logger({
1282
+ level: "WARN",
1283
+ message: `Parameter Validation warrnings for platform > Order > generateProcessManifest \n ${warrning}`,
1284
+ });
1285
+ }
1286
+
1287
+ const query_params = {};
1288
+
1289
+ const xHeaders = {};
1290
+
1291
+ const response = await PlatformAPIClient.execute(
1292
+ this.config,
1293
+ "post",
1294
+ `/service/platform/order-manage/v1.0/company/${this.config.companyId}/process-manifest`,
1295
+ query_params,
1296
+ body,
1297
+ { ...xHeaders, ...requestHeaders },
1298
+ { responseHeaders }
1299
+ );
1300
+
1301
+ let responseData = response;
1302
+ if (responseHeaders) {
1303
+ responseData = response[0];
1304
+ }
1305
+
1306
+ const {
1307
+ error: res_error,
1308
+ } = OrderPlatformModel.ManifestResponse().validate(responseData, {
1309
+ abortEarly: false,
1310
+ allowUnknown: true,
1311
+ });
1312
+
1313
+ if (res_error) {
1314
+ if (this.config.options.strictResponseCheck === true) {
1315
+ return Promise.reject(new FDKResponseValidationError(res_error));
1316
+ } else {
1317
+ Logger({
1318
+ level: "WARN",
1319
+ message: `Response Validation Warnings for platform > Order > generateProcessManifest \n ${res_error}`,
1320
+ });
1321
+ }
1322
+ }
1323
+
1324
+ return response;
1325
+ }
1326
+
1250
1327
  /**
1251
1328
  * @param {OrderPlatformValidator.GetAllowedStateTransitionParam} arg - Arg object
1252
1329
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -2376,7 +2453,7 @@ class Order {
2376
2453
  const response = await PlatformAPIClient.execute(
2377
2454
  this.config,
2378
2455
  "get",
2379
- `/service/platform/order-manage/v1.0/company/${this.config.companyId}/manifests/shipments`,
2456
+ `/service/platform/order-manage/v1.0/company/${this.config.companyId}/manifest/shipments-listing`,
2380
2457
  query_params,
2381
2458
  undefined,
2382
2459
  { ...xHeaders, ...requestHeaders },
@@ -445,7 +445,7 @@ export = OrderPlatformModel;
445
445
  */
446
446
  /**
447
447
  * @typedef DispatchManifest
448
- * @property {string} manifest_id
448
+ * @property {string} manifest_id - Id of the manifest.
449
449
  */
450
450
  /**
451
451
  * @typedef SuccessResponse
@@ -1163,15 +1163,18 @@ export = OrderPlatformModel;
1163
1163
  /**
1164
1164
  * @typedef Filters
1165
1165
  * @property {DateRange} [date_range]
1166
- * @property {string} [logo]
1167
- * @property {string} [from_date]
1168
- * @property {number} [stores]
1169
- * @property {string} [to_date]
1170
- * @property {string} [dp_name]
1171
- * @property {number} [dp_ids]
1172
- * @property {string} [lane]
1173
- * @property {string} [selected_shipments]
1174
- * @property {string} [store_name]
1166
+ * @property {string} [logo] - CDN link of the logo displayed on the manifest page.
1167
+ * @property {string} [from_date] - UTC start date in ISO format.
1168
+ * @property {number} [stores] - Filter with the specific store.
1169
+ * @property {string} [to_date] - UTC end date in ISO format.
1170
+ * @property {string} [dp_name] - Filter with the specific courier partner name.
1171
+ * @property {string} [dp_ids] - Combination of courier partner ids separated by
1172
+ * byte operator.
1173
+ * @property {string} [lane] - Criteria for lane on which shipments must be fetched.
1174
+ * @property {string} [selected_shipments] - Selected shipments mapped to the manifest.
1175
+ * @property {string} [store_name] - Filter with the specific store name.
1176
+ * @property {string} [deselected_shipments] - Deselected shipments unmapped
1177
+ * from the manifest.
1175
1178
  */
1176
1179
  /**
1177
1180
  * @typedef ManifestFile
@@ -1250,10 +1253,10 @@ export = OrderPlatformModel;
1250
1253
  */
1251
1254
  /**
1252
1255
  * @typedef ProcessManifestResponse
1253
- * @property {number} [company_id]
1256
+ * @property {number} [company_id] - Id of the company.
1254
1257
  * @property {Filters} [filters]
1255
- * @property {string} [user_id]
1256
- * @property {string} [manifest_id]
1258
+ * @property {string} [user_id] - Id of the user.
1259
+ * @property {string} [manifest_id] - Id of the manifest.
1257
1260
  * @property {string} [action]
1258
1261
  * @property {string} [uid]
1259
1262
  * @property {string} [created_by]
@@ -1440,6 +1443,36 @@ export = OrderPlatformModel;
1440
1443
  * @typedef GenerateInvoiceIDErrorResponse
1441
1444
  * @property {GenerateInvoiceIDErrorResponseData[]} [items]
1442
1445
  */
1446
+ /**
1447
+ * @typedef ManifestResponse
1448
+ * @property {ManifestItems} [items]
1449
+ */
1450
+ /**
1451
+ * @typedef ProcessManifestRequest
1452
+ * @property {string} [action] - Expected Actions: [save, process,
1453
+ * pdf_generated,invalidate,pdf_failed,complete]
1454
+ * @property {string} [manifest_id] - Id of The Manifest.
1455
+ * @property {Filters} [filters]
1456
+ * @property {string} [unique_id] - Unique Id.
1457
+ */
1458
+ /**
1459
+ * @typedef ManifestItems
1460
+ * @property {Filters} [filters]
1461
+ * @property {string} [manifest_id] - Id of the manifest.
1462
+ * @property {string} [unique_id] - Unique Id.
1463
+ * @property {number} [company_id] - Id of the company.
1464
+ * @property {string} [dp_id] - Shipment with the specific courier partner Id.
1465
+ * @property {string} [courier_partner_slug]
1466
+ * @property {string} [action] - Expected Actions: [Save, Process, Pdf
1467
+ * Generated, Invalidate, Pdf Failed, Complete]
1468
+ * @property {string} [created_by] - Created date of the manifest.
1469
+ * @property {string} [user_id] - Id of user.
1470
+ */
1471
+ /**
1472
+ * @typedef ManifestErrorResponse
1473
+ * @property {boolean} [success] - Success State.
1474
+ * @property {string} [error] - Error String.
1475
+ */
1443
1476
  /**
1444
1477
  * @typedef Page
1445
1478
  * @property {number} [item_total]
@@ -2835,7 +2868,7 @@ export = OrderPlatformModel;
2835
2868
  declare class OrderPlatformModel {
2836
2869
  }
2837
2870
  declare namespace OrderPlatformModel {
2838
- export { InvalidateShipmentCachePayload, InvalidateShipmentCacheNestedResponse, InvalidateShipmentCacheResponse, ErrorResponse, StoreReassign, StoreReassignResponse, Entities, UpdateShipmentLockPayload, OriginalFilter, Bags, CheckResponse, UpdateShipmentLockResponse, AnnouncementResponse, AnnouncementsResponse, BaseResponse, Click2CallResponse, ErrorDetail, ProductsReasonsFilters, ProductsReasonsData, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, OrderItemDataUpdates, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, DataUpdates, ShipmentsRequest, StatuesRequest, UpdateShipmentStatusRequest, ShipmentsResponse, StatuesResponse, UpdateShipmentStatusResponseBody, OrderUser, OrderPriority, ArticleDetails, LocationDetails, ShipmentDetails, ShipmentConfig, ShipmentData, MarketPlacePdf, AffiliateBag, UserData, OrderInfo, AffiliateAppConfigMeta, AffiliateAppConfig, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateInventoryOrderConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryConfig, AffiliateConfig, Affiliate, AffiliateStoreIdMapping, OrderConfig, CreateOrderPayload, CreateOrderResponse, DispatchManifest, SuccessResponse, ActionInfo, GetActionsResponse, HistoryReason, HistoryMeta, HistoryDict, ShipmentHistoryResponse, PostHistoryFilters, PostHistoryData, PostHistoryDict, PostShipmentHistory, SmsDataPayload, SendSmsPayload, OrderDetails, Meta, ShipmentDetail, OrderStatusData, OrderStatusResult, Dimension, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponse, Tax, Charge, LineItem, ProcessingDates, Shipment, ShippingInfo, BillingInfo, UserInfo, TaxInfo, PaymentMethod, PaymentInfo, CreateOrderAPI, CreateOrderErrorReponse, DpConfiguration, PaymentMethods, CreateChannelPaymentInfo, CreateChannelConfig, CreateChannelConfigData, CreateChannelConifgErrorResponse, CreateChannelConfigResponse, UploadConsent, PlatformOrderUpdate, ResponseDetail, FyndOrderIdList, OrderStatus, BagStateTransitionMap, RoleBaseStateTransitionMapping, FetchCreditBalanceRequestPayload, CreditBalanceInfo, FetchCreditBalanceResponsePayload, RefundModeConfigRequestPayload, RefundOption, RefundModeInfo, RefundModeConfigResponsePayload, AttachUserOtpData, AttachUserInfo, AttachOrderUser, AttachOrderUserResponse, SendUserMobileOTP, PointBlankOtpData, SendUserMobileOtpResponse, VerifyOtpData, VerifyMobileOTP, VerifyOtpResponseData, VerifyOtpResponse, BulkReportsDownloadRequest, BulkReportsDownloadResponse, BulkFailedResponse, BulkStateTransistionRequest, BulkStateTransistionResponse, ShipmentActionInfo, BulkActionListingData, BulkListinPage, BulkListingResponse, JobDetailsData, JobDetailsResponse, JobFailedResponse, ManifestPageInfo, ManifestItemDetails, ManifestShipmentListing, DateRange, Filters, ManifestFile, ManifestMediaUpdate, PDFMeta, TotalShipmentPricesCount, ManifestMeta, Manifest, ManifestList, ManifestDetails, FiltersRequest, ProcessManifest, ProcessManifestResponse, ProcessManifestItemResponse, FilterInfoOption, FiltersInfo, ManifestFiltersResponse, PageDetails, EInvoiceIrnDetails, EInvoiceErrorDetails, EInvoiceDetails, EInvoiceResponseData, EInvoiceRetry, EInvoiceRetryResponse, EInvoiceErrorInfo, EInvoiceErrorResponseData, EInvoiceErrorResponse, EInvoiceErrorResponseDetails, EInvoiceRetryShipmentData, CourierPartnerTrackingDetails, CourierPartnerTrackingResponse, LogsChannelDetails, LogPaymentDetails, FailedOrdersItem, FailedOrderLogs, FailedOrderLogDetails, GenerateInvoiceIDResponseData, GenerateInvoiceIDErrorResponseData, GenerateInvoiceIDRequest, GenerateInvoiceIDResponse, GenerateInvoiceIDErrorResponse, Page, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentStatus, UserDataInfo, PlatformDeliveryAddress, ShipmentListingChannel, Prices, Identifier, FinancialBreakup, GSTDetailsData, BagStateMapper, BagStatusHistory, Dimensions, ReturnConfig, Weight, Article, ShipmentListingBrand, ReplacementDetails, AffiliateMeta, AffiliateBagDetails, PlatformArticleAttributes, PlatformItem, Dates, BagReturnableCancelableStatus, BagUnit, ShipmentItemFulFillingStore, Currency, OrderingCurrency, ConversionRate, CurrencyInfo, ShipmentItem, ShipmentInternalPlatformViewResponse, TrackingList, InvoiceInfo, OrderDetailsData, UserDetailsData, PhoneDetails, ContactDetails, CompanyDetails, OrderingStoreDetails, DPDetailsData, BuyerDetails, DebugInfo, EinvoiceInfo, Formatted, ShipmentTags, LockData, ShipmentTimeStamp, ShipmentMeta, PDFLinks, AffiliateDetails, BagConfigs, OrderBagArticle, OrderBrandName, AffiliateBagsDetails, BagPaymentMethods, DiscountRules, ItemCriterias, BuyRules, AppliedPromos, CurrentStatus, OrderBags, FulfillingStore, ShipmentPayments, ShipmentStatusData, ShipmentLockDetails, PlatformShipment, ShipmentInfoResponse, TaxDetails, PaymentInfoData, OrderData, OrderDetailsResponse, SubLane, SuperLane, LaneConfigResponse, PlatformBreakupValues, PlatformChannel, PlatformOrderItems, OrderListingResponse, PlatformTrack, PlatformShipmentTrack, AdvanceFilterInfo, FiltersResponse, URL, FileResponse, BulkActionTemplate, BulkActionTemplateResponse, Reason, PlatformShipmentReasonsResponse, ShipmentResponseReasons, ShipmentReasonsResponse, StoreAddress, EInvoicePortalDetails, StoreEinvoice, StoreEwaybill, StoreGstCredentials, Document, StoreDocuments, StoreMeta, Store, Brand, Attributes, Item, ArticleStatusDetails, Company, ShipmentGstDetails, DeliverySlotDetails, InvoiceDetails, UserDetails, WeightData, BagDetails, BagDetailsPlatformResponse, BagsPage, BagData, GetBagsPlatformResponse, GeneratePosOrderReceiptResponse, Templates, AllowedTemplatesResponse, TemplateDownloadResponse, Error };
2871
+ export { InvalidateShipmentCachePayload, InvalidateShipmentCacheNestedResponse, InvalidateShipmentCacheResponse, ErrorResponse, StoreReassign, StoreReassignResponse, Entities, UpdateShipmentLockPayload, OriginalFilter, Bags, CheckResponse, UpdateShipmentLockResponse, AnnouncementResponse, AnnouncementsResponse, BaseResponse, Click2CallResponse, ErrorDetail, ProductsReasonsFilters, ProductsReasonsData, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, OrderItemDataUpdates, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, DataUpdates, ShipmentsRequest, StatuesRequest, UpdateShipmentStatusRequest, ShipmentsResponse, StatuesResponse, UpdateShipmentStatusResponseBody, OrderUser, OrderPriority, ArticleDetails, LocationDetails, ShipmentDetails, ShipmentConfig, ShipmentData, MarketPlacePdf, AffiliateBag, UserData, OrderInfo, AffiliateAppConfigMeta, AffiliateAppConfig, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateInventoryOrderConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryConfig, AffiliateConfig, Affiliate, AffiliateStoreIdMapping, OrderConfig, CreateOrderPayload, CreateOrderResponse, DispatchManifest, SuccessResponse, ActionInfo, GetActionsResponse, HistoryReason, HistoryMeta, HistoryDict, ShipmentHistoryResponse, PostHistoryFilters, PostHistoryData, PostHistoryDict, PostShipmentHistory, SmsDataPayload, SendSmsPayload, OrderDetails, Meta, ShipmentDetail, OrderStatusData, OrderStatusResult, Dimension, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponse, Tax, Charge, LineItem, ProcessingDates, Shipment, ShippingInfo, BillingInfo, UserInfo, TaxInfo, PaymentMethod, PaymentInfo, CreateOrderAPI, CreateOrderErrorReponse, DpConfiguration, PaymentMethods, CreateChannelPaymentInfo, CreateChannelConfig, CreateChannelConfigData, CreateChannelConifgErrorResponse, CreateChannelConfigResponse, UploadConsent, PlatformOrderUpdate, ResponseDetail, FyndOrderIdList, OrderStatus, BagStateTransitionMap, RoleBaseStateTransitionMapping, FetchCreditBalanceRequestPayload, CreditBalanceInfo, FetchCreditBalanceResponsePayload, RefundModeConfigRequestPayload, RefundOption, RefundModeInfo, RefundModeConfigResponsePayload, AttachUserOtpData, AttachUserInfo, AttachOrderUser, AttachOrderUserResponse, SendUserMobileOTP, PointBlankOtpData, SendUserMobileOtpResponse, VerifyOtpData, VerifyMobileOTP, VerifyOtpResponseData, VerifyOtpResponse, BulkReportsDownloadRequest, BulkReportsDownloadResponse, BulkFailedResponse, BulkStateTransistionRequest, BulkStateTransistionResponse, ShipmentActionInfo, BulkActionListingData, BulkListinPage, BulkListingResponse, JobDetailsData, JobDetailsResponse, JobFailedResponse, ManifestPageInfo, ManifestItemDetails, ManifestShipmentListing, DateRange, Filters, ManifestFile, ManifestMediaUpdate, PDFMeta, TotalShipmentPricesCount, ManifestMeta, Manifest, ManifestList, ManifestDetails, FiltersRequest, ProcessManifest, ProcessManifestResponse, ProcessManifestItemResponse, FilterInfoOption, FiltersInfo, ManifestFiltersResponse, PageDetails, EInvoiceIrnDetails, EInvoiceErrorDetails, EInvoiceDetails, EInvoiceResponseData, EInvoiceRetry, EInvoiceRetryResponse, EInvoiceErrorInfo, EInvoiceErrorResponseData, EInvoiceErrorResponse, EInvoiceErrorResponseDetails, EInvoiceRetryShipmentData, CourierPartnerTrackingDetails, CourierPartnerTrackingResponse, LogsChannelDetails, LogPaymentDetails, FailedOrdersItem, FailedOrderLogs, FailedOrderLogDetails, GenerateInvoiceIDResponseData, GenerateInvoiceIDErrorResponseData, GenerateInvoiceIDRequest, GenerateInvoiceIDResponse, GenerateInvoiceIDErrorResponse, ManifestResponse, ProcessManifestRequest, ManifestItems, ManifestErrorResponse, Page, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentStatus, UserDataInfo, PlatformDeliveryAddress, ShipmentListingChannel, Prices, Identifier, FinancialBreakup, GSTDetailsData, BagStateMapper, BagStatusHistory, Dimensions, ReturnConfig, Weight, Article, ShipmentListingBrand, ReplacementDetails, AffiliateMeta, AffiliateBagDetails, PlatformArticleAttributes, PlatformItem, Dates, BagReturnableCancelableStatus, BagUnit, ShipmentItemFulFillingStore, Currency, OrderingCurrency, ConversionRate, CurrencyInfo, ShipmentItem, ShipmentInternalPlatformViewResponse, TrackingList, InvoiceInfo, OrderDetailsData, UserDetailsData, PhoneDetails, ContactDetails, CompanyDetails, OrderingStoreDetails, DPDetailsData, BuyerDetails, DebugInfo, EinvoiceInfo, Formatted, ShipmentTags, LockData, ShipmentTimeStamp, ShipmentMeta, PDFLinks, AffiliateDetails, BagConfigs, OrderBagArticle, OrderBrandName, AffiliateBagsDetails, BagPaymentMethods, DiscountRules, ItemCriterias, BuyRules, AppliedPromos, CurrentStatus, OrderBags, FulfillingStore, ShipmentPayments, ShipmentStatusData, ShipmentLockDetails, PlatformShipment, ShipmentInfoResponse, TaxDetails, PaymentInfoData, OrderData, OrderDetailsResponse, SubLane, SuperLane, LaneConfigResponse, PlatformBreakupValues, PlatformChannel, PlatformOrderItems, OrderListingResponse, PlatformTrack, PlatformShipmentTrack, AdvanceFilterInfo, FiltersResponse, URL, FileResponse, BulkActionTemplate, BulkActionTemplateResponse, Reason, PlatformShipmentReasonsResponse, ShipmentResponseReasons, ShipmentReasonsResponse, StoreAddress, EInvoicePortalDetails, StoreEinvoice, StoreEwaybill, StoreGstCredentials, Document, StoreDocuments, StoreMeta, Store, Brand, Attributes, Item, ArticleStatusDetails, Company, ShipmentGstDetails, DeliverySlotDetails, InvoiceDetails, UserDetails, WeightData, BagDetails, BagDetailsPlatformResponse, BagsPage, BagData, GetBagsPlatformResponse, GeneratePosOrderReceiptResponse, Templates, AllowedTemplatesResponse, TemplateDownloadResponse, Error };
2839
2872
  }
2840
2873
  /** @returns {InvalidateShipmentCachePayload} */
2841
2874
  declare function InvalidateShipmentCachePayload(): InvalidateShipmentCachePayload;
@@ -3485,6 +3518,9 @@ type CreateOrderResponse = {
3485
3518
  /** @returns {DispatchManifest} */
3486
3519
  declare function DispatchManifest(): DispatchManifest;
3487
3520
  type DispatchManifest = {
3521
+ /**
3522
+ * - Id of the manifest.
3523
+ */
3488
3524
  manifest_id: string;
3489
3525
  };
3490
3526
  /** @returns {SuccessResponse} */
@@ -4388,15 +4424,48 @@ type DateRange = {
4388
4424
  declare function Filters(): Filters;
4389
4425
  type Filters = {
4390
4426
  date_range?: DateRange;
4427
+ /**
4428
+ * - CDN link of the logo displayed on the manifest page.
4429
+ */
4391
4430
  logo?: string;
4431
+ /**
4432
+ * - UTC start date in ISO format.
4433
+ */
4392
4434
  from_date?: string;
4435
+ /**
4436
+ * - Filter with the specific store.
4437
+ */
4393
4438
  stores?: number;
4439
+ /**
4440
+ * - UTC end date in ISO format.
4441
+ */
4394
4442
  to_date?: string;
4443
+ /**
4444
+ * - Filter with the specific courier partner name.
4445
+ */
4395
4446
  dp_name?: string;
4396
- dp_ids?: number;
4447
+ /**
4448
+ * - Combination of courier partner ids separated by
4449
+ * byte operator.
4450
+ */
4451
+ dp_ids?: string;
4452
+ /**
4453
+ * - Criteria for lane on which shipments must be fetched.
4454
+ */
4397
4455
  lane?: string;
4456
+ /**
4457
+ * - Selected shipments mapped to the manifest.
4458
+ */
4398
4459
  selected_shipments?: string;
4460
+ /**
4461
+ * - Filter with the specific store name.
4462
+ */
4399
4463
  store_name?: string;
4464
+ /**
4465
+ * - Deselected shipments unmapped
4466
+ * from the manifest.
4467
+ */
4468
+ deselected_shipments?: string;
4400
4469
  };
4401
4470
  /** @returns {ManifestFile} */
4402
4471
  declare function ManifestFile(): ManifestFile;
@@ -4486,9 +4555,18 @@ type ProcessManifest = {
4486
4555
  /** @returns {ProcessManifestResponse} */
4487
4556
  declare function ProcessManifestResponse(): ProcessManifestResponse;
4488
4557
  type ProcessManifestResponse = {
4558
+ /**
4559
+ * - Id of the company.
4560
+ */
4489
4561
  company_id?: number;
4490
4562
  filters?: Filters;
4563
+ /**
4564
+ * - Id of the user.
4565
+ */
4491
4566
  user_id?: string;
4567
+ /**
4568
+ * - Id of the manifest.
4569
+ */
4492
4570
  manifest_id?: string;
4493
4571
  action?: string;
4494
4572
  uid?: string;
@@ -4761,6 +4839,76 @@ declare function GenerateInvoiceIDErrorResponse(): GenerateInvoiceIDErrorRespons
4761
4839
  type GenerateInvoiceIDErrorResponse = {
4762
4840
  items?: GenerateInvoiceIDErrorResponseData[];
4763
4841
  };
4842
+ /** @returns {ManifestResponse} */
4843
+ declare function ManifestResponse(): ManifestResponse;
4844
+ type ManifestResponse = {
4845
+ items?: ManifestItems;
4846
+ };
4847
+ /** @returns {ProcessManifestRequest} */
4848
+ declare function ProcessManifestRequest(): ProcessManifestRequest;
4849
+ type ProcessManifestRequest = {
4850
+ /**
4851
+ * - Expected Actions: [save, process,
4852
+ * pdf_generated,invalidate,pdf_failed,complete]
4853
+ */
4854
+ action?: string;
4855
+ /**
4856
+ * - Id of The Manifest.
4857
+ */
4858
+ manifest_id?: string;
4859
+ filters?: Filters;
4860
+ /**
4861
+ * - Unique Id.
4862
+ */
4863
+ unique_id?: string;
4864
+ };
4865
+ /** @returns {ManifestItems} */
4866
+ declare function ManifestItems(): ManifestItems;
4867
+ type ManifestItems = {
4868
+ filters?: Filters;
4869
+ /**
4870
+ * - Id of the manifest.
4871
+ */
4872
+ manifest_id?: string;
4873
+ /**
4874
+ * - Unique Id.
4875
+ */
4876
+ unique_id?: string;
4877
+ /**
4878
+ * - Id of the company.
4879
+ */
4880
+ company_id?: number;
4881
+ /**
4882
+ * - Shipment with the specific courier partner Id.
4883
+ */
4884
+ dp_id?: string;
4885
+ courier_partner_slug?: string;
4886
+ /**
4887
+ * - Expected Actions: [Save, Process, Pdf
4888
+ * Generated, Invalidate, Pdf Failed, Complete]
4889
+ */
4890
+ action?: string;
4891
+ /**
4892
+ * - Created date of the manifest.
4893
+ */
4894
+ created_by?: string;
4895
+ /**
4896
+ * - Id of user.
4897
+ */
4898
+ user_id?: string;
4899
+ };
4900
+ /** @returns {ManifestErrorResponse} */
4901
+ declare function ManifestErrorResponse(): ManifestErrorResponse;
4902
+ type ManifestErrorResponse = {
4903
+ /**
4904
+ * - Success State.
4905
+ */
4906
+ success?: boolean;
4907
+ /**
4908
+ * - Error String.
4909
+ */
4910
+ error?: string;
4911
+ };
4764
4912
  /** @returns {Page} */
4765
4913
  declare function Page(): Page;
4766
4914
  type Page = {
@@ -506,7 +506,7 @@ const Joi = require("joi");
506
506
 
507
507
  /**
508
508
  * @typedef DispatchManifest
509
- * @property {string} manifest_id
509
+ * @property {string} manifest_id - Id of the manifest.
510
510
  */
511
511
 
512
512
  /**
@@ -1307,15 +1307,18 @@ const Joi = require("joi");
1307
1307
  /**
1308
1308
  * @typedef Filters
1309
1309
  * @property {DateRange} [date_range]
1310
- * @property {string} [logo]
1311
- * @property {string} [from_date]
1312
- * @property {number} [stores]
1313
- * @property {string} [to_date]
1314
- * @property {string} [dp_name]
1315
- * @property {number} [dp_ids]
1316
- * @property {string} [lane]
1317
- * @property {string} [selected_shipments]
1318
- * @property {string} [store_name]
1310
+ * @property {string} [logo] - CDN link of the logo displayed on the manifest page.
1311
+ * @property {string} [from_date] - UTC start date in ISO format.
1312
+ * @property {number} [stores] - Filter with the specific store.
1313
+ * @property {string} [to_date] - UTC end date in ISO format.
1314
+ * @property {string} [dp_name] - Filter with the specific courier partner name.
1315
+ * @property {string} [dp_ids] - Combination of courier partner ids separated by
1316
+ * byte operator.
1317
+ * @property {string} [lane] - Criteria for lane on which shipments must be fetched.
1318
+ * @property {string} [selected_shipments] - Selected shipments mapped to the manifest.
1319
+ * @property {string} [store_name] - Filter with the specific store name.
1320
+ * @property {string} [deselected_shipments] - Deselected shipments unmapped
1321
+ * from the manifest.
1319
1322
  */
1320
1323
 
1321
1324
  /**
@@ -1405,10 +1408,10 @@ const Joi = require("joi");
1405
1408
 
1406
1409
  /**
1407
1410
  * @typedef ProcessManifestResponse
1408
- * @property {number} [company_id]
1411
+ * @property {number} [company_id] - Id of the company.
1409
1412
  * @property {Filters} [filters]
1410
- * @property {string} [user_id]
1411
- * @property {string} [manifest_id]
1413
+ * @property {string} [user_id] - Id of the user.
1414
+ * @property {string} [manifest_id] - Id of the manifest.
1412
1415
  * @property {string} [action]
1413
1416
  * @property {string} [uid]
1414
1417
  * @property {string} [created_by]
@@ -1624,6 +1627,40 @@ const Joi = require("joi");
1624
1627
  * @property {GenerateInvoiceIDErrorResponseData[]} [items]
1625
1628
  */
1626
1629
 
1630
+ /**
1631
+ * @typedef ManifestResponse
1632
+ * @property {ManifestItems} [items]
1633
+ */
1634
+
1635
+ /**
1636
+ * @typedef ProcessManifestRequest
1637
+ * @property {string} [action] - Expected Actions: [save, process,
1638
+ * pdf_generated,invalidate,pdf_failed,complete]
1639
+ * @property {string} [manifest_id] - Id of The Manifest.
1640
+ * @property {Filters} [filters]
1641
+ * @property {string} [unique_id] - Unique Id.
1642
+ */
1643
+
1644
+ /**
1645
+ * @typedef ManifestItems
1646
+ * @property {Filters} [filters]
1647
+ * @property {string} [manifest_id] - Id of the manifest.
1648
+ * @property {string} [unique_id] - Unique Id.
1649
+ * @property {number} [company_id] - Id of the company.
1650
+ * @property {string} [dp_id] - Shipment with the specific courier partner Id.
1651
+ * @property {string} [courier_partner_slug]
1652
+ * @property {string} [action] - Expected Actions: [Save, Process, Pdf
1653
+ * Generated, Invalidate, Pdf Failed, Complete]
1654
+ * @property {string} [created_by] - Created date of the manifest.
1655
+ * @property {string} [user_id] - Id of user.
1656
+ */
1657
+
1658
+ /**
1659
+ * @typedef ManifestErrorResponse
1660
+ * @property {boolean} [success] - Success State.
1661
+ * @property {string} [error] - Error String.
1662
+ */
1663
+
1627
1664
  /**
1628
1665
  * @typedef Page
1629
1666
  * @property {number} [item_total]
@@ -4747,10 +4784,11 @@ class OrderPlatformModel {
4747
4784
  stores: Joi.number(),
4748
4785
  to_date: Joi.string().allow(""),
4749
4786
  dp_name: Joi.string().allow(""),
4750
- dp_ids: Joi.number(),
4787
+ dp_ids: Joi.string().allow(""),
4751
4788
  lane: Joi.string().allow(""),
4752
4789
  selected_shipments: Joi.string().allow(""),
4753
4790
  store_name: Joi.string().allow(""),
4791
+ deselected_shipments: Joi.string().allow(""),
4754
4792
  });
4755
4793
  }
4756
4794
 
@@ -5156,6 +5194,46 @@ class OrderPlatformModel {
5156
5194
  });
5157
5195
  }
5158
5196
 
5197
+ /** @returns {ManifestResponse} */
5198
+ static ManifestResponse() {
5199
+ return Joi.object({
5200
+ items: OrderPlatformModel.ManifestItems(),
5201
+ });
5202
+ }
5203
+
5204
+ /** @returns {ProcessManifestRequest} */
5205
+ static ProcessManifestRequest() {
5206
+ return Joi.object({
5207
+ action: Joi.string().allow(""),
5208
+ manifest_id: Joi.string().allow(""),
5209
+ filters: OrderPlatformModel.Filters(),
5210
+ unique_id: Joi.string().allow(""),
5211
+ });
5212
+ }
5213
+
5214
+ /** @returns {ManifestItems} */
5215
+ static ManifestItems() {
5216
+ return Joi.object({
5217
+ filters: OrderPlatformModel.Filters(),
5218
+ manifest_id: Joi.string().allow(""),
5219
+ unique_id: Joi.string().allow(""),
5220
+ company_id: Joi.number(),
5221
+ dp_id: Joi.string().allow("").allow(null),
5222
+ courier_partner_slug: Joi.string().allow(""),
5223
+ action: Joi.string().allow(""),
5224
+ created_by: Joi.string().allow(""),
5225
+ user_id: Joi.string().allow(""),
5226
+ });
5227
+ }
5228
+
5229
+ /** @returns {ManifestErrorResponse} */
5230
+ static ManifestErrorResponse() {
5231
+ return Joi.object({
5232
+ success: Joi.boolean(),
5233
+ error: Joi.string().allow(""),
5234
+ });
5235
+ }
5236
+
5159
5237
  /** @returns {Page} */
5160
5238
  static Page() {
5161
5239
  return Joi.object({