@gofynd/fdk-client-javascript 1.4.3 → 1.4.5

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 (125) hide show
  1. package/README.md +1 -10
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +48 -48
  4. package/sdk/application/Cart/CartApplicationClient.js +48 -48
  5. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +69 -69
  6. package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
  7. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  8. package/sdk/application/Common/CommonApplicationClient.js +4 -4
  9. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
  10. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
  11. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -32
  12. package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
  13. package/sdk/application/Content/ContentApplicationClient.d.ts +45 -45
  14. package/sdk/application/Content/ContentApplicationClient.js +45 -45
  15. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +5 -5
  16. package/sdk/application/FileStorage/FileStorageApplicationClient.js +5 -5
  17. package/sdk/application/Lead/LeadApplicationClient.d.ts +9 -9
  18. package/sdk/application/Lead/LeadApplicationClient.js +9 -9
  19. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +22 -22
  20. package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
  21. package/sdk/application/Order/OrderApplicationClient.d.ts +14 -25
  22. package/sdk/application/Order/OrderApplicationClient.js +14 -94
  23. package/sdk/application/Order/OrderApplicationValidator.d.ts +1 -15
  24. package/sdk/application/Order/OrderApplicationValidator.js +0 -13
  25. package/sdk/application/Payment/PaymentApplicationClient.d.ts +71 -71
  26. package/sdk/application/Payment/PaymentApplicationClient.js +71 -71
  27. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +1 -1
  28. package/sdk/application/Rewards/RewardsApplicationClient.js +1 -1
  29. package/sdk/application/Share/ShareApplicationClient.d.ts +1 -1
  30. package/sdk/application/Share/ShareApplicationClient.js +1 -1
  31. package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
  32. package/sdk/application/Share/ShareApplicationModel.js +2 -0
  33. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
  34. package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
  35. package/sdk/application/User/UserApplicationClient.d.ts +74 -74
  36. package/sdk/application/User/UserApplicationClient.js +74 -74
  37. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +5 -5
  38. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +5 -5
  39. package/sdk/platform/Billing/BillingPlatformClient.d.ts +13 -13
  40. package/sdk/platform/Billing/BillingPlatformClient.js +13 -13
  41. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +102 -102
  42. package/sdk/platform/Cart/CartPlatformApplicationClient.js +102 -102
  43. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +132 -131
  44. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +132 -131
  45. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +130 -130
  46. package/sdk/platform/Catalog/CatalogPlatformClient.js +130 -130
  47. package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
  48. package/sdk/platform/Common/CommonPlatformClient.js +2 -2
  49. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +118 -118
  50. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +118 -118
  51. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
  52. package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
  53. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +22 -22
  54. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +22 -22
  55. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +34 -7
  56. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +35 -5
  57. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +4 -4
  58. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +4 -4
  59. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +41 -41
  60. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +41 -41
  61. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +26 -26
  62. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +26 -26
  63. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +93 -93
  64. package/sdk/platform/Content/ContentPlatformApplicationClient.js +93 -93
  65. package/sdk/platform/Content/ContentPlatformClient.d.ts +29 -29
  66. package/sdk/platform/Content/ContentPlatformClient.js +29 -29
  67. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +18 -18
  68. package/sdk/platform/Discount/DiscountPlatformClient.js +18 -18
  69. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -17
  70. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +18 -17
  71. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
  72. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
  73. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +2 -2
  74. package/sdk/platform/Finance/FinancePlatformClient.d.ts +4 -4
  75. package/sdk/platform/Finance/FinancePlatformClient.js +4 -4
  76. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
  77. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
  78. package/sdk/platform/Lead/LeadPlatformClient.d.ts +15 -15
  79. package/sdk/platform/Lead/LeadPlatformClient.js +15 -15
  80. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +10 -10
  81. package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
  82. package/sdk/platform/Order/OrderPlatformClient.d.ts +95 -106
  83. package/sdk/platform/Order/OrderPlatformClient.js +95 -190
  84. package/sdk/platform/Order/OrderPlatformModel.d.ts +10 -0
  85. package/sdk/platform/Order/OrderPlatformModel.js +4 -0
  86. package/sdk/platform/Order/OrderPlatformValidator.d.ts +1 -33
  87. package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
  88. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
  89. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
  90. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +77 -77
  91. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +77 -77
  92. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +2 -2
  93. package/sdk/platform/Payment/PaymentPlatformClient.js +2 -2
  94. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
  95. package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
  96. package/sdk/platform/PlatformClient.d.ts +0 -2
  97. package/sdk/platform/PlatformClient.js +0 -4
  98. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +7 -7
  99. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +7 -7
  100. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +40 -40
  101. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
  102. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +51 -50
  103. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +51 -50
  104. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +1 -1
  105. package/sdk/platform/Share/SharePlatformApplicationClient.js +1 -1
  106. package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
  107. package/sdk/platform/Share/SharePlatformModel.js +2 -0
  108. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +34 -104
  109. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +34 -591
  110. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +1 -100
  111. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
  112. package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
  113. package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
  114. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +35 -35
  115. package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
  116. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +7 -6
  117. package/sdk/platform/Webhook/WebhookPlatformClient.js +7 -6
  118. package/sdk/platform/index.d.ts +0 -1
  119. package/sdk/platform/index.js +0 -2
  120. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +0 -152
  121. package/sdk/platform/Inventory/InventoryPlatformClient.js +0 -1017
  122. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +0 -1355
  123. package/sdk/platform/Inventory/InventoryPlatformModel.js +0 -1544
  124. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +0 -171
  125. package/sdk/platform/Inventory/InventoryPlatformValidator.js +0 -159
@@ -65,6 +65,8 @@ export = OrderPlatformModel;
65
65
  * operational, financial]
66
66
  * @property {Entities[]} entities - Shipment/Entity
67
67
  * @property {boolean} [resume_tasks_after_unlock]
68
+ * @property {boolean} [lock_after_transition] - Lock Shipment After Transition
69
+ * @property {boolean} [unlock_before_transition] - Unlock Shipment After Transition
68
70
  */
69
71
  /**
70
72
  * @typedef OriginalFilter
@@ -2948,6 +2950,14 @@ type UpdateShipmentLockPayload = {
2948
2950
  */
2949
2951
  entities: Entities[];
2950
2952
  resume_tasks_after_unlock?: boolean;
2953
+ /**
2954
+ * - Lock Shipment After Transition
2955
+ */
2956
+ lock_after_transition?: boolean;
2957
+ /**
2958
+ * - Unlock Shipment After Transition
2959
+ */
2960
+ unlock_before_transition?: boolean;
2951
2961
  };
2952
2962
  /** @returns {OriginalFilter} */
2953
2963
  declare function OriginalFilter(): OriginalFilter;
@@ -73,6 +73,8 @@ const Joi = require("joi");
73
73
  * operational, financial]
74
74
  * @property {Entities[]} entities - Shipment/Entity
75
75
  * @property {boolean} [resume_tasks_after_unlock]
76
+ * @property {boolean} [lock_after_transition] - Lock Shipment After Transition
77
+ * @property {boolean} [unlock_before_transition] - Unlock Shipment After Transition
76
78
  */
77
79
 
78
80
  /**
@@ -3221,6 +3223,8 @@ class OrderPlatformModel {
3221
3223
  action_type: Joi.string().allow("").required(),
3222
3224
  entities: Joi.array().items(OrderPlatformModel.Entities()).required(),
3223
3225
  resume_tasks_after_unlock: Joi.boolean().allow(null),
3226
+ lock_after_transition: Joi.boolean(),
3227
+ unlock_before_transition: Joi.boolean(),
3224
3228
  });
3225
3229
  }
3226
3230
 
@@ -21,14 +21,6 @@ export = OrderPlatformValidator;
21
21
  * @typedef CheckOrderStatusParam
22
22
  * @property {OrderPlatformModel.OrderStatus} body
23
23
  */
24
- /**
25
- * @typedef Click2CallParam
26
- * @property {string} caller - Call Number
27
- * @property {string} receiver - Receiver Number
28
- * @property {string} bagId - Bag Id for the query
29
- * @property {string} [callerId] - Caller Id
30
- * @property {string} [method] - Provider Method to Call
31
- */
32
24
  /**
33
25
  * @typedef CreateChannelConfigParam
34
26
  * @property {OrderPlatformModel.CreateChannelConfigData} body
@@ -384,8 +376,6 @@ declare class OrderPlatformValidator {
384
376
  static bulkStateTransistion(): BulkStateTransistionParam;
385
377
  /** @returns {CheckOrderStatusParam} */
386
378
  static checkOrderStatus(): CheckOrderStatusParam;
387
- /** @returns {Click2CallParam} */
388
- static click2Call(): Click2CallParam;
389
379
  /** @returns {CreateChannelConfigParam} */
390
380
  static createChannelConfig(): CreateChannelConfigParam;
391
381
  /** @returns {CreateOrderParam} */
@@ -490,7 +480,7 @@ declare class OrderPlatformValidator {
490
480
  static verifyMobileOTP(): VerifyMobileOTPParam;
491
481
  }
492
482
  declare namespace OrderPlatformValidator {
493
- export { AttachOrderUserParam, BulkListingParam, BulkStateTransistionParam, CheckOrderStatusParam, Click2CallParam, CreateChannelConfigParam, CreateOrderParam, DispatchManifestsParam, DownloadBulkActionTemplateParam, DownloadLanesReportParam, EInvoiceRetryParam, FailedOrderLogDetailsParam, FetchCreditBalanceDetailParam, FetchRefundModeConfigParam, GenerateInvoiceIDParam, GeneratePOSReceiptByOrderIdParam, GetAllowedStateTransitionParam, GetAllowedTemplatesForBulkParam, GetAnnouncementsParam, GetBagByIdParam, GetBagsParam, GetBulkActionTemplateParam, GetBulkShipmentExcelFileParam, GetChannelConfigParam, GetFileByStatusParam, GetLaneConfigParam, GetManifestDetailsParam, GetManifestShipmentsParam, GetManifestfiltersParam, GetManifestsParam, GetOrderByIdParam, GetOrdersParam, GetRoleBasedActionsParam, GetShipmentByIdParam, GetShipmentHistoryParam, GetShipmentReasonsParam, GetShipmentsParam, GetStateTransitionMapParam, GetTemplateParam, GetfiltersParam, InvalidateShipmentCacheParam, JobDetailsParam, OrderUpdateParam, PostShipmentHistoryParam, ProcessManifestsParam, ReassignLocationParam, SendSmsNinjaParam, SendUserMobileOTPParam, TrackShipmentParam, UpdateAddressParam, UpdatePackagingDimensionsParam, UpdateShipmentLockParam, UpdateShipmentStatusParam, UpdateShipmentTrackingParam, UploadConsentsParam, VerifyMobileOTPParam };
483
+ export { AttachOrderUserParam, BulkListingParam, BulkStateTransistionParam, CheckOrderStatusParam, CreateChannelConfigParam, CreateOrderParam, DispatchManifestsParam, DownloadBulkActionTemplateParam, DownloadLanesReportParam, EInvoiceRetryParam, FailedOrderLogDetailsParam, FetchCreditBalanceDetailParam, FetchRefundModeConfigParam, GenerateInvoiceIDParam, GeneratePOSReceiptByOrderIdParam, GetAllowedStateTransitionParam, GetAllowedTemplatesForBulkParam, GetAnnouncementsParam, GetBagByIdParam, GetBagsParam, GetBulkActionTemplateParam, GetBulkShipmentExcelFileParam, GetChannelConfigParam, GetFileByStatusParam, GetLaneConfigParam, GetManifestDetailsParam, GetManifestShipmentsParam, GetManifestfiltersParam, GetManifestsParam, GetOrderByIdParam, GetOrdersParam, GetRoleBasedActionsParam, GetShipmentByIdParam, GetShipmentHistoryParam, GetShipmentReasonsParam, GetShipmentsParam, GetStateTransitionMapParam, GetTemplateParam, GetfiltersParam, InvalidateShipmentCacheParam, JobDetailsParam, OrderUpdateParam, PostShipmentHistoryParam, ProcessManifestsParam, ReassignLocationParam, SendSmsNinjaParam, SendUserMobileOTPParam, TrackShipmentParam, UpdateAddressParam, UpdatePackagingDimensionsParam, UpdateShipmentLockParam, UpdateShipmentStatusParam, UpdateShipmentTrackingParam, UploadConsentsParam, VerifyMobileOTPParam };
494
484
  }
495
485
  type AttachOrderUserParam = {
496
486
  body: OrderPlatformModel.AttachOrderUser;
@@ -531,28 +521,6 @@ type BulkStateTransistionParam = {
531
521
  type CheckOrderStatusParam = {
532
522
  body: OrderPlatformModel.OrderStatus;
533
523
  };
534
- type Click2CallParam = {
535
- /**
536
- * - Call Number
537
- */
538
- caller: string;
539
- /**
540
- * - Receiver Number
541
- */
542
- receiver: string;
543
- /**
544
- * - Bag Id for the query
545
- */
546
- bagId: string;
547
- /**
548
- * - Caller Id
549
- */
550
- callerId?: string;
551
- /**
552
- * - Provider Method to Call
553
- */
554
- method?: string;
555
- };
556
524
  type CreateChannelConfigParam = {
557
525
  body: OrderPlatformModel.CreateChannelConfigData;
558
526
  };
@@ -28,15 +28,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
28
28
  * @property {OrderPlatformModel.OrderStatus} body
29
29
  */
30
30
 
31
- /**
32
- * @typedef Click2CallParam
33
- * @property {string} caller - Call Number
34
- * @property {string} receiver - Receiver Number
35
- * @property {string} bagId - Bag Id for the query
36
- * @property {string} [callerId] - Caller Id
37
- * @property {string} [method] - Provider Method to Call
38
- */
39
-
40
31
  /**
41
32
  * @typedef CreateChannelConfigParam
42
33
  * @property {OrderPlatformModel.CreateChannelConfigData} body
@@ -469,17 +460,6 @@ class OrderPlatformValidator {
469
460
  }).required();
470
461
  }
471
462
 
472
- /** @returns {Click2CallParam} */
473
- static click2Call() {
474
- return Joi.object({
475
- caller: Joi.string().allow("").required(),
476
- receiver: Joi.string().allow("").required(),
477
- bagId: Joi.string().allow("").required(),
478
- callerId: Joi.string().allow(""),
479
- method: Joi.string().allow(""),
480
- }).required();
481
- }
482
-
483
463
  /** @returns {CreateChannelConfigParam} */
484
464
  static createChannelConfig() {
485
465
  return Joi.object({
@@ -9,8 +9,8 @@ declare class Partner {
9
9
  * @param {import("../PlatformAPIClient").Options} - Options
10
10
  * @returns {Promise<PartnerPlatformModel.AddProxyResponse>} - Success response
11
11
  * @name addProxyPath
12
- * @summary: Add proxy path
13
- * @description: Create and add a new proxy path. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/addProxyPath/).
12
+ * @summary: Create extension proxy
13
+ * @description: Extension proxy can be used to call extension API from storefront and make extension API integration seamless. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/addProxyPath/).
14
14
  */
15
15
  addProxyPath({ extensionId, body, requestHeaders }?: PartnerPlatformApplicationValidator.AddProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.AddProxyResponse>;
16
16
  /**
@@ -19,8 +19,8 @@ declare class Partner {
19
19
  * @param {import("../PlatformAPIClient").Options} - Options
20
20
  * @returns {Promise<PartnerPlatformModel.RemoveProxyResponse>} - Success response
21
21
  * @name removeProxyPath
22
- * @summary: Remove proxy path
23
- * @description: Delete a proxy path from the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/removeProxyPath/).
22
+ * @summary: Remove extension proxy
23
+ * @description: Remove the proxy which are created earlier for the extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/removeProxyPath/).
24
24
  */
25
25
  removeProxyPath({ extensionId, attachedPath, requestHeaders }?: PartnerPlatformApplicationValidator.RemoveProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.RemoveProxyResponse>;
26
26
  }
@@ -21,8 +21,8 @@ class Partner {
21
21
  * @param {import("../PlatformAPIClient").Options} - Options
22
22
  * @returns {Promise<PartnerPlatformModel.AddProxyResponse>} - Success response
23
23
  * @name addProxyPath
24
- * @summary: Add proxy path
25
- * @description: Create and add a new proxy path. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/addProxyPath/).
24
+ * @summary: Create extension proxy
25
+ * @description: Extension proxy can be used to call extension API from storefront and make extension API integration seamless. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/addProxyPath/).
26
26
  */
27
27
  async addProxyPath(
28
28
  { extensionId, body, requestHeaders } = { requestHeaders: {} },
@@ -102,8 +102,8 @@ class Partner {
102
102
  * @param {import("../PlatformAPIClient").Options} - Options
103
103
  * @returns {Promise<PartnerPlatformModel.RemoveProxyResponse>} - Success response
104
104
  * @name removeProxyPath
105
- * @summary: Remove proxy path
106
- * @description: Delete a proxy path from the platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/removeProxyPath/).
105
+ * @summary: Remove extension proxy
106
+ * @description: Remove the proxy which are created earlier for the extension. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/partner/removeProxyPath/).
107
107
  */
108
108
  async removeProxyPath(
109
109
  { extensionId, attachedPath, requestHeaders } = { requestHeaders: {} },