@gofynd/fdk-client-javascript 1.4.15-beta.1 → 1.4.15-beta.10

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 (154) hide show
  1. package/README.md +2 -2
  2. package/application.d.ts +1 -2
  3. package/application.js +2 -3
  4. package/index.d.ts +1 -2
  5. package/index.js +7 -1
  6. package/package.json +2 -3
  7. package/sdk/application/ApplicationClient.js +0 -18
  8. package/sdk/application/Cart/CartApplicationClient.d.ts +55 -90
  9. package/sdk/application/Cart/CartApplicationClient.js +60 -1185
  10. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +80 -142
  11. package/sdk/application/Catalog/CatalogApplicationClient.js +148 -1293
  12. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -8
  13. package/sdk/application/Common/CommonApplicationClient.js +5 -89
  14. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -19
  15. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -145
  16. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -73
  17. package/sdk/application/Configuration/ConfigurationApplicationClient.js +31 -718
  18. package/sdk/application/Content/ContentApplicationClient.d.ts +46 -78
  19. package/sdk/application/Content/ContentApplicationClient.js +77 -914
  20. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +9 -12
  21. package/sdk/application/FileStorage/FileStorageApplicationClient.js +22 -125
  22. package/sdk/application/Lead/LeadApplicationClient.d.ts +10 -18
  23. package/sdk/application/Lead/LeadApplicationClient.js +32 -202
  24. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +22 -39
  25. package/sdk/application/Logistic/LogisticApplicationClient.js +50 -478
  26. package/sdk/application/Order/OrderApplicationClient.d.ts +22 -42
  27. package/sdk/application/Order/OrderApplicationClient.js +86 -472
  28. package/sdk/application/Payment/PaymentApplicationClient.d.ts +92 -212
  29. package/sdk/application/Payment/PaymentApplicationClient.js +57 -2102
  30. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -28
  31. package/sdk/application/Rewards/RewardsApplicationClient.js +16 -305
  32. package/sdk/application/Share/ShareApplicationClient.d.ts +14 -24
  33. package/sdk/application/Share/ShareApplicationClient.js +34 -294
  34. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -14
  35. package/sdk/application/Theme/ThemeApplicationClient.js +28 -162
  36. package/sdk/application/User/UserApplicationClient.d.ts +85 -136
  37. package/sdk/application/User/UserApplicationClient.js +45 -1815
  38. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +2 -5
  39. package/sdk/application/Webhook/WebhookApplicationClient.js +4 -47
  40. package/sdk/application/index.d.ts +0 -18
  41. package/sdk/application/index.js +0 -33
  42. package/sdk/common/Utility.d.ts +1 -1
  43. package/sdk/common/Utility.js +10 -7
  44. package/sdk/common/Validator.d.ts +1 -0
  45. package/sdk/common/Validator.js +20 -0
  46. package/sdk/common/utils.d.ts +0 -1
  47. package/sdk/common/utils.js +0 -14
  48. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +2 -0
  49. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +2 -0
  50. package/sdk/partner/OAuthClient.js +1 -0
  51. package/sdk/partner/Theme/ThemePartnerModel.d.ts +3 -40
  52. package/sdk/partner/Theme/ThemePartnerModel.js +2 -24
  53. package/sdk/platform/Cart/CartPlatformModel.d.ts +28 -0
  54. package/sdk/platform/Cart/CartPlatformModel.js +12 -0
  55. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +0 -7
  56. package/sdk/platform/Catalog/CatalogPlatformModel.js +1 -4
  57. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +14 -0
  58. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +6 -0
  59. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +3 -1
  60. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +3 -0
  61. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +3 -1
  62. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +3 -0
  63. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +16 -1
  64. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +20 -0
  65. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +0 -10
  66. package/sdk/platform/Order/OrderPlatformApplicationClient.js +0 -92
  67. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -28
  68. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -18
  69. package/sdk/platform/Order/OrderPlatformClient.d.ts +10 -0
  70. package/sdk/platform/Order/OrderPlatformClient.js +99 -0
  71. package/sdk/platform/Order/OrderPlatformModel.d.ts +7 -0
  72. package/sdk/platform/Order/OrderPlatformModel.js +3 -0
  73. package/sdk/platform/Order/OrderPlatformValidator.d.ts +33 -1
  74. package/sdk/platform/Order/OrderPlatformValidator.js +20 -0
  75. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +1 -1
  76. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +4 -4
  77. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +56 -19
  78. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +42 -18
  79. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +3 -3
  80. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -2
  81. package/sdk/platform/Theme/ThemePlatformModel.d.ts +3 -40
  82. package/sdk/platform/Theme/ThemePlatformModel.js +2 -24
  83. package/sdk/public/Configuration/ConfigurationPublicClient.js +5 -2
  84. package/sdk/public/Content/ContentPublicClient.d.ts +1 -1
  85. package/sdk/public/Content/ContentPublicClient.js +14 -2
  86. package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
  87. package/sdk/public/Partner/PartnerPublicClient.js +14 -2
  88. package/sdk/public/Webhook/WebhookPublicClient.js +5 -2
  89. package/sdk/application/Cart/CartApplicationModel.d.ts +0 -3994
  90. package/sdk/application/Cart/CartApplicationModel.js +0 -2497
  91. package/sdk/application/Cart/CartApplicationValidator.d.ts +0 -769
  92. package/sdk/application/Cart/CartApplicationValidator.js +0 -530
  93. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +0 -3857
  94. package/sdk/application/Catalog/CatalogApplicationModel.js +0 -2629
  95. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +0 -791
  96. package/sdk/application/Catalog/CatalogApplicationValidator.js +0 -551
  97. package/sdk/application/Common/CommonApplicationModel.d.ts +0 -449
  98. package/sdk/application/Common/CommonApplicationModel.js +0 -308
  99. package/sdk/application/Common/CommonApplicationValidator.d.ts +0 -46
  100. package/sdk/application/Common/CommonApplicationValidator.js +0 -38
  101. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +0 -293
  102. package/sdk/application/Communication/CommunicationApplicationModel.js +0 -201
  103. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +0 -29
  104. package/sdk/application/Communication/CommunicationApplicationValidator.js +0 -38
  105. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +0 -2556
  106. package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -1887
  107. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +0 -179
  108. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +0 -176
  109. package/sdk/application/Content/ContentApplicationModel.d.ts +0 -2133
  110. package/sdk/application/Content/ContentApplicationModel.js +0 -1589
  111. package/sdk/application/Content/ContentApplicationValidator.d.ts +0 -284
  112. package/sdk/application/Content/ContentApplicationValidator.js +0 -264
  113. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +0 -272
  114. package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -190
  115. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +0 -56
  116. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +0 -53
  117. package/sdk/application/Lead/LeadApplicationModel.d.ts +0 -590
  118. package/sdk/application/Lead/LeadApplicationModel.js +0 -480
  119. package/sdk/application/Lead/LeadApplicationValidator.d.ts +0 -68
  120. package/sdk/application/Lead/LeadApplicationValidator.js +0 -71
  121. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +0 -1675
  122. package/sdk/application/Logistic/LogisticApplicationModel.js +0 -1121
  123. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +0 -254
  124. package/sdk/application/Logistic/LogisticApplicationValidator.js +0 -190
  125. package/sdk/application/Order/OrderApplicationModel.d.ts +0 -2296
  126. package/sdk/application/Order/OrderApplicationModel.js +0 -1471
  127. package/sdk/application/Order/OrderApplicationValidator.d.ts +0 -265
  128. package/sdk/application/Order/OrderApplicationValidator.js +0 -197
  129. package/sdk/application/Payment/PaymentApplicationModel.d.ts +0 -4058
  130. package/sdk/application/Payment/PaymentApplicationModel.js +0 -2630
  131. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +0 -576
  132. package/sdk/application/Payment/PaymentApplicationValidator.js +0 -594
  133. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +0 -365
  134. package/sdk/application/Rewards/RewardsApplicationModel.js +0 -396
  135. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +0 -73
  136. package/sdk/application/Rewards/RewardsApplicationValidator.js +0 -84
  137. package/sdk/application/Share/ShareApplicationModel.d.ts +0 -339
  138. package/sdk/application/Share/ShareApplicationModel.js +0 -234
  139. package/sdk/application/Share/ShareApplicationValidator.d.ts +0 -90
  140. package/sdk/application/Share/ShareApplicationValidator.js +0 -91
  141. package/sdk/application/Theme/ThemeApplicationModel.d.ts +0 -1713
  142. package/sdk/application/Theme/ThemeApplicationModel.js +0 -1426
  143. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +0 -66
  144. package/sdk/application/Theme/ThemeApplicationValidator.js +0 -58
  145. package/sdk/application/User/UserApplicationModel.d.ts +0 -1943
  146. package/sdk/application/User/UserApplicationModel.js +0 -1382
  147. package/sdk/application/User/UserApplicationValidator.d.ts +0 -560
  148. package/sdk/application/User/UserApplicationValidator.js +0 -573
  149. package/sdk/application/Webhook/WebhookApplicationModel.d.ts +0 -52
  150. package/sdk/application/Webhook/WebhookApplicationModel.js +0 -46
  151. package/sdk/application/Webhook/WebhookApplicationValidator.d.ts +0 -16
  152. package/sdk/application/Webhook/WebhookApplicationValidator.js +0 -19
  153. package/sdk/common/Clickstream.d.ts +0 -1
  154. package/sdk/common/Clickstream.js +0 -464
@@ -152,14 +152,16 @@ declare class FileStorage {
152
152
  * @param {string} namespace
153
153
  * @param {number} size
154
154
  * @param {number} tags
155
+ * @param {string} enc_key
155
156
  */
156
- upload({ data, file_name, content_type, namespace, size, tags, }?: {
157
+ upload({ data, file_name, content_type, namespace, size, tags, enc_key, }?: {
157
158
  data: any;
158
159
  file_name: any;
159
160
  content_type: any;
160
161
  namespace: any;
161
162
  size: any;
162
163
  tags: any;
164
+ enc_key: any;
163
165
  }): Promise<any>;
164
166
  }
165
167
  import FileStoragePlatformApplicationValidator = require("./FileStoragePlatformApplicationValidator");
@@ -1045,6 +1045,7 @@ class FileStorage {
1045
1045
  * @param {string} namespace
1046
1046
  * @param {number} size
1047
1047
  * @param {number} tags
1048
+ * @param {string} enc_key
1048
1049
  */
1049
1050
  FileStorage.prototype.upload = function ({
1050
1051
  data,
@@ -1053,6 +1054,7 @@ FileStorage.prototype.upload = function ({
1053
1054
  namespace,
1054
1055
  size,
1055
1056
  tags,
1057
+ enc_key,
1056
1058
  } = {}) {
1057
1059
  return new Promise(async (resolve, reject) => {
1058
1060
  try {
@@ -1063,6 +1065,7 @@ FileStorage.prototype.upload = function ({
1063
1065
  content_type,
1064
1066
  size: size,
1065
1067
  tags: tags,
1068
+ enc_key: enc_key,
1066
1069
  },
1067
1070
  });
1068
1071
  if (dataObj.upload && dataObj.upload.url) {
@@ -69,14 +69,16 @@ declare class FileStorage {
69
69
  * @param {string} namespace
70
70
  * @param {number} size
71
71
  * @param {number} tags
72
+ * @param {string} enc_key
72
73
  */
73
- upload({ data, file_name, content_type, namespace, size, tags, }?: {
74
+ upload({ data, file_name, content_type, namespace, size, tags, enc_key, }?: {
74
75
  data: any;
75
76
  file_name: any;
76
77
  content_type: any;
77
78
  namespace: any;
78
79
  size: any;
79
80
  tags: any;
81
+ enc_key: any;
80
82
  }): Promise<any>;
81
83
  }
82
84
  import FileStoragePlatformValidator = require("./FileStoragePlatformValidator");
@@ -510,6 +510,7 @@ class FileStorage {
510
510
  * @param {string} namespace
511
511
  * @param {number} size
512
512
  * @param {number} tags
513
+ * @param {string} enc_key
513
514
  */
514
515
  FileStorage.prototype.upload = function ({
515
516
  data,
@@ -518,6 +519,7 @@ FileStorage.prototype.upload = function ({
518
519
  namespace,
519
520
  size,
520
521
  tags,
522
+ enc_key,
521
523
  } = {}) {
522
524
  return new Promise(async (resolve, reject) => {
523
525
  try {
@@ -528,6 +530,7 @@ FileStorage.prototype.upload = function ({
528
530
  content_type,
529
531
  size: size,
530
532
  tags: tags,
533
+ enc_key: enc_key,
531
534
  },
532
535
  });
533
536
  if (dataObj.upload && dataObj.upload.url) {
@@ -43,6 +43,7 @@ export = FileStoragePlatformModel;
43
43
  * @property {number} size
44
44
  * @property {string[]} [tags]
45
45
  * @property {Object} [params]
46
+ * @property {string} [enc_key]
46
47
  */
47
48
  /**
48
49
  * @typedef CreatedBy
@@ -85,10 +86,16 @@ export = FileStoragePlatformModel;
85
86
  * @typedef SignUrlResponse
86
87
  * @property {Urls[]} urls
87
88
  */
89
+ /**
90
+ * @typedef EncryptionMapping
91
+ * @property {string} [enc_url]
92
+ * @property {string} [value]
93
+ */
88
94
  /**
89
95
  * @typedef SignUrlRequest
90
96
  * @property {number} expiry
91
97
  * @property {string[]} urls
98
+ * @property {EncryptionMapping[]} [enc_url_mapping]
92
99
  */
93
100
  /**
94
101
  * @typedef InvoiceTypesDataResponse
@@ -570,7 +577,7 @@ export = FileStoragePlatformModel;
570
577
  declare class FileStoragePlatformModel {
571
578
  }
572
579
  declare namespace FileStoragePlatformModel {
573
- export { ProxyResponse, FailedResponse, CDN, Upload, StartResponse, Params, StartRequest, CreatedBy, CompleteResponse, DestinationNamespace, CopyFiles, Urls, SignUrlResponse, SignUrlRequest, InvoiceTypesDataResponse, InvoiceTypesResponse, ConversionRate, DeliveryPartnerDetail, Image, PaymentData, InvoiceDetail, CompanyDetail, StoreDetail, CustomerBillingDetail, CustomerShippingDetail, ReturnDetail, Brand, Cgst, Sgst, Igst, Tax, ItemsProductTable, ProductTable, Taxes, TaxTable, RegisteredCompanyDetail, Kwargs, ShipmentIdBarcodeGenerator, SignedQrcodeGenerator, KwargsUpiQrcode, UpiQrcodeGenerator, DigitalsignatureGenerator, KwargsAwbNumber, AwbNumberLabelBarcodeGenerator, AwbNumberBarcodeGenerator, MetaProperty, Meta, DummyTemplateDataPayload, DummyTemplateData, DummyTemplateDataItems, PdfConfig, PdfConfigSuccessData, PdfConfigSuccess, PdfConfigSaveSuccessData, PdfConfigSaveSuccess, PdfDefaultTemplateSuccess, Document, PaymentReceiptRequestBody, PaymentReceiptOrderDetails, PaymentReceiptCustomerDetails, PaymentReceiptPayments, PaymentReceiptFormat, PaymentReceiptService, PaymentReceiptTaxes, PaymentReceiptPayload, PaymentReceiptMeta, ExtensionSlug };
580
+ export { ProxyResponse, FailedResponse, CDN, Upload, StartResponse, Params, StartRequest, CreatedBy, CompleteResponse, DestinationNamespace, CopyFiles, Urls, SignUrlResponse, EncryptionMapping, SignUrlRequest, InvoiceTypesDataResponse, InvoiceTypesResponse, ConversionRate, DeliveryPartnerDetail, Image, PaymentData, InvoiceDetail, CompanyDetail, StoreDetail, CustomerBillingDetail, CustomerShippingDetail, ReturnDetail, Brand, Cgst, Sgst, Igst, Tax, ItemsProductTable, ProductTable, Taxes, TaxTable, RegisteredCompanyDetail, Kwargs, ShipmentIdBarcodeGenerator, SignedQrcodeGenerator, KwargsUpiQrcode, UpiQrcodeGenerator, DigitalsignatureGenerator, KwargsAwbNumber, AwbNumberLabelBarcodeGenerator, AwbNumberBarcodeGenerator, MetaProperty, Meta, DummyTemplateDataPayload, DummyTemplateData, DummyTemplateDataItems, PdfConfig, PdfConfigSuccessData, PdfConfigSuccess, PdfConfigSaveSuccessData, PdfConfigSaveSuccess, PdfDefaultTemplateSuccess, Document, PaymentReceiptRequestBody, PaymentReceiptOrderDetails, PaymentReceiptCustomerDetails, PaymentReceiptPayments, PaymentReceiptFormat, PaymentReceiptService, PaymentReceiptTaxes, PaymentReceiptPayload, PaymentReceiptMeta, ExtensionSlug };
574
581
  }
575
582
  /** @returns {ProxyResponse} */
576
583
  declare function ProxyResponse(): ProxyResponse;
@@ -626,6 +633,7 @@ type StartRequest = {
626
633
  size: number;
627
634
  tags?: string[];
628
635
  params?: any;
636
+ enc_key?: string;
629
637
  };
630
638
  /** @returns {CreatedBy} */
631
639
  declare function CreatedBy(): CreatedBy;
@@ -674,11 +682,18 @@ declare function SignUrlResponse(): SignUrlResponse;
674
682
  type SignUrlResponse = {
675
683
  urls: Urls[];
676
684
  };
685
+ /** @returns {EncryptionMapping} */
686
+ declare function EncryptionMapping(): EncryptionMapping;
687
+ type EncryptionMapping = {
688
+ enc_url?: string;
689
+ value?: string;
690
+ };
677
691
  /** @returns {SignUrlRequest} */
678
692
  declare function SignUrlRequest(): SignUrlRequest;
679
693
  type SignUrlRequest = {
680
694
  expiry: number;
681
695
  urls: string[];
696
+ enc_url_mapping?: EncryptionMapping[];
682
697
  };
683
698
  /** @returns {InvoiceTypesDataResponse} */
684
699
  declare function InvoiceTypesDataResponse(): InvoiceTypesDataResponse;
@@ -50,6 +50,7 @@ const Joi = require("joi");
50
50
  * @property {number} size
51
51
  * @property {string[]} [tags]
52
52
  * @property {Object} [params]
53
+ * @property {string} [enc_key]
53
54
  */
54
55
 
55
56
  /**
@@ -99,10 +100,17 @@ const Joi = require("joi");
99
100
  * @property {Urls[]} urls
100
101
  */
101
102
 
103
+ /**
104
+ * @typedef EncryptionMapping
105
+ * @property {string} [enc_url]
106
+ * @property {string} [value]
107
+ */
108
+
102
109
  /**
103
110
  * @typedef SignUrlRequest
104
111
  * @property {number} expiry
105
112
  * @property {string[]} urls
113
+ * @property {EncryptionMapping[]} [enc_url_mapping]
106
114
  */
107
115
 
108
116
  /**
@@ -699,6 +707,7 @@ class FileStoragePlatformModel {
699
707
  size: Joi.number().required(),
700
708
  tags: Joi.array().items(Joi.string().allow("")),
701
709
  params: Joi.object().pattern(/\S/, Joi.any()),
710
+ enc_key: Joi.string().allow(""),
702
711
  });
703
712
  }
704
713
 
@@ -761,11 +770,22 @@ class FileStoragePlatformModel {
761
770
  });
762
771
  }
763
772
 
773
+ /** @returns {EncryptionMapping} */
774
+ static EncryptionMapping() {
775
+ return Joi.object({
776
+ enc_url: Joi.string().allow(""),
777
+ value: Joi.string().allow(""),
778
+ });
779
+ }
780
+
764
781
  /** @returns {SignUrlRequest} */
765
782
  static SignUrlRequest() {
766
783
  return Joi.object({
767
784
  expiry: Joi.number().required(),
768
785
  urls: Joi.array().items(Joi.string().allow("")).required(),
786
+ enc_url_mapping: Joi.array().items(
787
+ FileStoragePlatformModel.EncryptionMapping()
788
+ ),
769
789
  });
770
790
  }
771
791
 
@@ -3,16 +3,6 @@ declare class Order {
3
3
  constructor(config: any, applicationId: any);
4
4
  config: any;
5
5
  applicationId: any;
6
- /**
7
- * @param {OrderPlatformApplicationValidator.FailedOrderLogsParam} arg - Arg object
8
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
9
- * @param {import("../PlatformAPIClient").Options} - Options
10
- * @returns {Promise<OrderPlatformModel.FailedOrderLogs>} - Success response
11
- * @name failedOrderLogs
12
- * @summary: List failed order logs
13
- * @description: Get failed order logs listing for filters based on order Id, user contact number, user email Id and sales channel Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/failedOrderLogs/).
14
- */
15
- failedOrderLogs({ pageNo, pageSize, searchType, searchValue, requestHeaders }?: OrderPlatformApplicationValidator.FailedOrderLogsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FailedOrderLogs>;
16
6
  /**
17
7
  * @param {OrderPlatformApplicationValidator.GetApplicationShipmentsParam} arg
18
8
  * - Arg object
@@ -15,98 +15,6 @@ class Order {
15
15
  this.applicationId = applicationId;
16
16
  }
17
17
 
18
- /**
19
- * @param {OrderPlatformApplicationValidator.FailedOrderLogsParam} arg - Arg object
20
- * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
21
- * @param {import("../PlatformAPIClient").Options} - Options
22
- * @returns {Promise<OrderPlatformModel.FailedOrderLogs>} - Success response
23
- * @name failedOrderLogs
24
- * @summary: List failed order logs
25
- * @description: Get failed order logs listing for filters based on order Id, user contact number, user email Id and sales channel Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/failedOrderLogs/).
26
- */
27
- async failedOrderLogs(
28
- { pageNo, pageSize, searchType, searchValue, requestHeaders } = {
29
- requestHeaders: {},
30
- },
31
- { responseHeaders } = { responseHeaders: false }
32
- ) {
33
- const {
34
- error,
35
- } = OrderPlatformApplicationValidator.failedOrderLogs().validate(
36
- {
37
- pageNo,
38
- pageSize,
39
- searchType,
40
- searchValue,
41
- },
42
- { abortEarly: false, allowUnknown: true }
43
- );
44
- if (error) {
45
- return Promise.reject(new FDKClientValidationError(error));
46
- }
47
-
48
- // Showing warrnings if extra unknown parameters are found
49
- const {
50
- error: warrning,
51
- } = OrderPlatformApplicationValidator.failedOrderLogs().validate(
52
- {
53
- pageNo,
54
- pageSize,
55
- searchType,
56
- searchValue,
57
- },
58
- { abortEarly: false, allowUnknown: false }
59
- );
60
- if (warrning) {
61
- Logger({
62
- level: "WARN",
63
- message: `Parameter Validation warrnings for platform > Order > failedOrderLogs \n ${warrning}`,
64
- });
65
- }
66
-
67
- const query_params = {};
68
- query_params["application_id"] = applicationId;
69
- query_params["page_no"] = pageNo;
70
- query_params["page_size"] = pageSize;
71
- query_params["search_type"] = searchType;
72
- query_params["search_value"] = searchValue;
73
-
74
- const response = await PlatformAPIClient.execute(
75
- this.config,
76
- "get",
77
- `/service/platform/order-manage/v1.0/company/${this.config.companyId}/orders/failed`,
78
- query_params,
79
- undefined,
80
- requestHeaders,
81
- { responseHeaders }
82
- );
83
-
84
- let responseData = response;
85
- if (responseHeaders) {
86
- responseData = response[0];
87
- }
88
-
89
- const {
90
- error: res_error,
91
- } = OrderPlatformModel.FailedOrderLogs().validate(responseData, {
92
- abortEarly: false,
93
- allowUnknown: true,
94
- });
95
-
96
- if (res_error) {
97
- if (this.config.options.strictResponseCheck === true) {
98
- return Promise.reject(new FDKResponseValidationError(res_error));
99
- } else {
100
- Logger({
101
- level: "WARN",
102
- message: `Response Validation Warnings for platform > Order > failedOrderLogs \n ${res_error}`,
103
- });
104
- }
105
- }
106
-
107
- return response;
108
- }
109
-
110
18
  /**
111
19
  * @param {OrderPlatformApplicationValidator.GetApplicationShipmentsParam} arg
112
20
  * - Arg object
@@ -1,11 +1,4 @@
1
1
  export = OrderPlatformApplicationValidator;
2
- /**
3
- * @typedef FailedOrderLogsParam
4
- * @property {number} [pageNo] - Page Number
5
- * @property {number} [pageSize] - Page Size
6
- * @property {string} [searchType] - Search type for filter
7
- * @property {string} [searchValue] - Search value for filter
8
- */
9
2
  /**
10
3
  * @typedef GetApplicationShipmentsParam
11
4
  * @property {string} [lane]
@@ -39,8 +32,6 @@ export = OrderPlatformApplicationValidator;
39
32
  * @property {string} shipmentId - Shipment Id
40
33
  */
41
34
  declare class OrderPlatformApplicationValidator {
42
- /** @returns {FailedOrderLogsParam} */
43
- static failedOrderLogs(): FailedOrderLogsParam;
44
35
  /** @returns {GetApplicationShipmentsParam} */
45
36
  static getApplicationShipments(): GetApplicationShipmentsParam;
46
37
  /** @returns {GetPlatformShipmentReasonsParam} */
@@ -51,26 +42,8 @@ declare class OrderPlatformApplicationValidator {
51
42
  static trackShipmentPlatform(): TrackShipmentPlatformParam;
52
43
  }
53
44
  declare namespace OrderPlatformApplicationValidator {
54
- export { FailedOrderLogsParam, GetApplicationShipmentsParam, GetPlatformShipmentReasonsParam, GetShipmentBagReasonsParam, TrackShipmentPlatformParam };
45
+ export { GetApplicationShipmentsParam, GetPlatformShipmentReasonsParam, GetShipmentBagReasonsParam, TrackShipmentPlatformParam };
55
46
  }
56
- type FailedOrderLogsParam = {
57
- /**
58
- * - Page Number
59
- */
60
- pageNo?: number;
61
- /**
62
- * - Page Size
63
- */
64
- pageSize?: number;
65
- /**
66
- * - Search type for filter
67
- */
68
- searchType?: string;
69
- /**
70
- * - Search value for filter
71
- */
72
- searchValue?: string;
73
- };
74
47
  type GetApplicationShipmentsParam = {
75
48
  lane?: string;
76
49
  searchType?: string;
@@ -2,14 +2,6 @@ const Joi = require("joi");
2
2
 
3
3
  const OrderPlatformModel = require("./OrderPlatformModel");
4
4
 
5
- /**
6
- * @typedef FailedOrderLogsParam
7
- * @property {number} [pageNo] - Page Number
8
- * @property {number} [pageSize] - Page Size
9
- * @property {string} [searchType] - Search type for filter
10
- * @property {string} [searchValue] - Search value for filter
11
- */
12
-
13
5
  /**
14
6
  * @typedef GetApplicationShipmentsParam
15
7
  * @property {string} [lane]
@@ -47,16 +39,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
47
39
  */
48
40
 
49
41
  class OrderPlatformApplicationValidator {
50
- /** @returns {FailedOrderLogsParam} */
51
- static failedOrderLogs() {
52
- return Joi.object({
53
- pageNo: Joi.number(),
54
- pageSize: Joi.number(),
55
- searchType: Joi.string().allow(""),
56
- searchValue: Joi.string().allow(""),
57
- }).required();
58
- }
59
-
60
42
  /** @returns {GetApplicationShipmentsParam} */
61
43
  static getApplicationShipments() {
62
44
  return Joi.object({
@@ -114,6 +114,16 @@ declare class Order {
114
114
  * @description: Get the exact error trace from the log Id provided in the failed order list API response - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/failedOrderLogDetails/).
115
115
  */
116
116
  failedOrderLogDetails({ logId, requestHeaders }?: OrderPlatformValidator.FailedOrderLogDetailsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FailedOrderLogDetails>;
117
+ /**
118
+ * @param {OrderPlatformValidator.FailedOrderLogsParam} arg - Arg object
119
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
120
+ * @param {import("../PlatformAPIClient").Options} - Options
121
+ * @returns {Promise<OrderPlatformModel.FailedOrderLogs>} - Success response
122
+ * @name failedOrderLogs
123
+ * @summary: List failed order logs
124
+ * @description: Get failed order logs listing for filters based on order Id, user contact number, user email Id and sales channel Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/failedOrderLogs/).
125
+ */
126
+ failedOrderLogs({ applicationId, pageNo, pageSize, searchType, searchValue, requestHeaders, }?: OrderPlatformValidator.FailedOrderLogsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FailedOrderLogs>;
117
127
  /**
118
128
  * @param {OrderPlatformValidator.FetchRefundModeConfigParam} arg - Arg object
119
129
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -910,6 +910,105 @@ class Order {
910
910
  return response;
911
911
  }
912
912
 
913
+ /**
914
+ * @param {OrderPlatformValidator.FailedOrderLogsParam} arg - Arg object
915
+ * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
916
+ * @param {import("../PlatformAPIClient").Options} - Options
917
+ * @returns {Promise<OrderPlatformModel.FailedOrderLogs>} - Success response
918
+ * @name failedOrderLogs
919
+ * @summary: List failed order logs
920
+ * @description: Get failed order logs listing for filters based on order Id, user contact number, user email Id and sales channel Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/failedOrderLogs/).
921
+ */
922
+ async failedOrderLogs(
923
+ {
924
+ applicationId,
925
+ pageNo,
926
+ pageSize,
927
+ searchType,
928
+ searchValue,
929
+ requestHeaders,
930
+ } = { requestHeaders: {} },
931
+ { responseHeaders } = { responseHeaders: false }
932
+ ) {
933
+ const { error } = OrderPlatformValidator.failedOrderLogs().validate(
934
+ {
935
+ applicationId,
936
+ pageNo,
937
+ pageSize,
938
+ searchType,
939
+ searchValue,
940
+ },
941
+ { abortEarly: false, allowUnknown: true }
942
+ );
943
+ if (error) {
944
+ return Promise.reject(new FDKClientValidationError(error));
945
+ }
946
+
947
+ // Showing warrnings if extra unknown parameters are found
948
+ const {
949
+ error: warrning,
950
+ } = OrderPlatformValidator.failedOrderLogs().validate(
951
+ {
952
+ applicationId,
953
+ pageNo,
954
+ pageSize,
955
+ searchType,
956
+ searchValue,
957
+ },
958
+ { abortEarly: false, allowUnknown: false }
959
+ );
960
+ if (warrning) {
961
+ Logger({
962
+ level: "WARN",
963
+ message: `Parameter Validation warrnings for platform > Order > failedOrderLogs \n ${warrning}`,
964
+ });
965
+ }
966
+
967
+ const query_params = {};
968
+ query_params["application_id"] = applicationId;
969
+ query_params["page_no"] = pageNo;
970
+ query_params["page_size"] = pageSize;
971
+ query_params["search_type"] = searchType;
972
+ query_params["search_value"] = searchValue;
973
+
974
+ const xHeaders = {};
975
+
976
+ const response = await PlatformAPIClient.execute(
977
+ this.config,
978
+ "get",
979
+ `/service/platform/order-manage/v1.0/company/${this.config.companyId}/orders/failed`,
980
+ query_params,
981
+ undefined,
982
+ { ...xHeaders, ...requestHeaders },
983
+ { responseHeaders }
984
+ );
985
+
986
+ let responseData = response;
987
+ if (responseHeaders) {
988
+ responseData = response[0];
989
+ }
990
+
991
+ const {
992
+ error: res_error,
993
+ } = OrderPlatformModel.FailedOrderLogs().validate(responseData, {
994
+ abortEarly: false,
995
+ allowUnknown: true,
996
+ });
997
+
998
+ if (res_error) {
999
+ if (this.config.options.strictResponseCheck === true) {
1000
+ return Promise.reject(new FDKResponseValidationError(res_error));
1001
+ } else {
1002
+ Logger({
1003
+ level: "WARN",
1004
+ message: `Response Validation Warnings for platform > Order > failedOrderLogs \n ${res_error}`,
1005
+ });
1006
+ }
1007
+ }
1008
+
1009
+ return response;
1010
+ }
1011
+
913
1012
  /**
914
1013
  * @param {OrderPlatformValidator.FetchRefundModeConfigParam} arg - Arg object
915
1014
  * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -812,6 +812,8 @@ export = OrderPlatformModel;
812
812
  * or system that is making the order request.
813
813
  * @property {string} [external_shipment_id] - External shipment identifier or
814
814
  * marketplace's unique shipment identifier.
815
+ * @property {Object} [custom_json] - An object containing additional metadata,
816
+ * ensuring only the required fields are included as needed.
815
817
  */
816
818
  /**
817
819
  * @typedef CreateOrderErrorReponse
@@ -4930,6 +4932,11 @@ type CreateOrderAPI = {
4930
4932
  * marketplace's unique shipment identifier.
4931
4933
  */
4932
4934
  external_shipment_id?: string;
4935
+ /**
4936
+ * - An object containing additional metadata,
4937
+ * ensuring only the required fields are included as needed.
4938
+ */
4939
+ custom_json?: any;
4933
4940
  };
4934
4941
  /** @returns {CreateOrderErrorReponse} */
4935
4942
  declare function CreateOrderErrorReponse(): CreateOrderErrorReponse;
@@ -886,6 +886,8 @@ const Joi = require("joi");
886
886
  * or system that is making the order request.
887
887
  * @property {string} [external_shipment_id] - External shipment identifier or
888
888
  * marketplace's unique shipment identifier.
889
+ * @property {Object} [custom_json] - An object containing additional metadata,
890
+ * ensuring only the required fields are included as needed.
889
891
  */
890
892
 
891
893
  /**
@@ -4298,6 +4300,7 @@ class OrderPlatformModel {
4298
4300
  fynd_order_id: Joi.string().allow(""),
4299
4301
  application_id: Joi.string().allow(""),
4300
4302
  external_shipment_id: Joi.string().allow(""),
4303
+ custom_json: Joi.any().allow(null),
4301
4304
  });
4302
4305
  }
4303
4306
 
@@ -51,6 +51,14 @@ export = OrderPlatformValidator;
51
51
  * @typedef FailedOrderLogDetailsParam
52
52
  * @property {string} logId - Log Error ID
53
53
  */
54
+ /**
55
+ * @typedef FailedOrderLogsParam
56
+ * @property {string} [applicationId] - Application ID
57
+ * @property {number} [pageNo] - Page Number
58
+ * @property {number} [pageSize] - Page Size
59
+ * @property {string} [searchType] - Search type for filter
60
+ * @property {string} [searchValue] - Search value for filter
61
+ */
54
62
  /**
55
63
  * @typedef FetchRefundModeConfigParam
56
64
  * @property {OrderPlatformModel.RefundModeConfigRequestPayload} body
@@ -410,6 +418,8 @@ declare class OrderPlatformValidator {
410
418
  static eInvoiceRetry(): EInvoiceRetryParam;
411
419
  /** @returns {FailedOrderLogDetailsParam} */
412
420
  static failedOrderLogDetails(): FailedOrderLogDetailsParam;
421
+ /** @returns {FailedOrderLogsParam} */
422
+ static failedOrderLogs(): FailedOrderLogsParam;
413
423
  /** @returns {FetchRefundModeConfigParam} */
414
424
  static fetchRefundModeConfig(): FetchRefundModeConfigParam;
415
425
  /** @returns {GenerateInvoiceIDParam} */
@@ -498,7 +508,7 @@ declare class OrderPlatformValidator {
498
508
  static verifyMobileOTP(): VerifyMobileOTPParam;
499
509
  }
500
510
  declare namespace OrderPlatformValidator {
501
- export { AddStateManagerConfigParam, AttachOrderUserParam, BulkListingParam, BulkStateTransistionParam, CheckOrderStatusParam, CreateOrderParam, DispatchManifestsParam, DownloadBulkActionTemplateParam, DownloadLanesReportParam, EInvoiceRetryParam, FailedOrderLogDetailsParam, FetchRefundModeConfigParam, GenerateInvoiceIDParam, GeneratePOSReceiptByOrderIdParam, GenerateProcessManifestParam, GetAllowedStateTransitionParam, GetAllowedTemplatesForBulkParam, GetAnnouncementsParam, GetBagByIdParam, GetBagsParam, GetBulkActionTemplateParam, GetBulkShipmentExcelFileParam, GetFileByStatusParam, GetLaneConfigParam, GetManifestDetailsParam, GetManifestShipmentsParam, GetManifestfiltersParam, GetManifestsParam, GetOrderByIdParam, GetOrdersParam, GetRoleBasedActionsParam, GetShipmentByIdParam, GetShipmentHistoryParam, GetShipmentReasonsParam, GetShipmentsParam, GetStateManagerConfigParam, GetStateTransitionMapParam, GetTemplateParam, GetfiltersParam, InvalidateShipmentCacheParam, JobDetailsParam, OrderUpdateParam, PostShipmentHistoryParam, ReassignLocationParam, SendSmsNinjaParam, SendUserMobileOTPParam, TrackShipmentParam, UpdateAddressParam, UpdatePackagingDimensionsParam, UpdateShipmentLockParam, UpdateShipmentStatusParam, UpdateShipmentTrackingParam, UploadConsentsParam, VerifyMobileOTPParam };
511
+ export { AddStateManagerConfigParam, AttachOrderUserParam, BulkListingParam, BulkStateTransistionParam, CheckOrderStatusParam, CreateOrderParam, DispatchManifestsParam, DownloadBulkActionTemplateParam, DownloadLanesReportParam, EInvoiceRetryParam, FailedOrderLogDetailsParam, FailedOrderLogsParam, FetchRefundModeConfigParam, GenerateInvoiceIDParam, GeneratePOSReceiptByOrderIdParam, GenerateProcessManifestParam, GetAllowedStateTransitionParam, GetAllowedTemplatesForBulkParam, GetAnnouncementsParam, GetBagByIdParam, GetBagsParam, GetBulkActionTemplateParam, GetBulkShipmentExcelFileParam, GetFileByStatusParam, GetLaneConfigParam, GetManifestDetailsParam, GetManifestShipmentsParam, GetManifestfiltersParam, GetManifestsParam, GetOrderByIdParam, GetOrdersParam, GetRoleBasedActionsParam, GetShipmentByIdParam, GetShipmentHistoryParam, GetShipmentReasonsParam, GetShipmentsParam, GetStateManagerConfigParam, GetStateTransitionMapParam, GetTemplateParam, GetfiltersParam, InvalidateShipmentCacheParam, JobDetailsParam, OrderUpdateParam, PostShipmentHistoryParam, ReassignLocationParam, SendSmsNinjaParam, SendUserMobileOTPParam, TrackShipmentParam, UpdateAddressParam, UpdatePackagingDimensionsParam, UpdateShipmentLockParam, UpdateShipmentStatusParam, UpdateShipmentTrackingParam, UploadConsentsParam, VerifyMobileOTPParam };
502
512
  }
503
513
  type AddStateManagerConfigParam = {
504
514
  body: OrderPlatformModel.TransitionConfigPayload;
@@ -568,6 +578,28 @@ type FailedOrderLogDetailsParam = {
568
578
  */
569
579
  logId: string;
570
580
  };
581
+ type FailedOrderLogsParam = {
582
+ /**
583
+ * - Application ID
584
+ */
585
+ applicationId?: string;
586
+ /**
587
+ * - Page Number
588
+ */
589
+ pageNo?: number;
590
+ /**
591
+ * - Page Size
592
+ */
593
+ pageSize?: number;
594
+ /**
595
+ * - Search type for filter
596
+ */
597
+ searchType?: string;
598
+ /**
599
+ * - Search value for filter
600
+ */
601
+ searchValue?: string;
602
+ };
571
603
  type FetchRefundModeConfigParam = {
572
604
  body: OrderPlatformModel.RefundModeConfigRequestPayload;
573
605
  };
@@ -65,6 +65,15 @@ const OrderPlatformModel = require("./OrderPlatformModel");
65
65
  * @property {string} logId - Log Error ID
66
66
  */
67
67
 
68
+ /**
69
+ * @typedef FailedOrderLogsParam
70
+ * @property {string} [applicationId] - Application ID
71
+ * @property {number} [pageNo] - Page Number
72
+ * @property {number} [pageSize] - Page Size
73
+ * @property {string} [searchType] - Search type for filter
74
+ * @property {string} [searchValue] - Search value for filter
75
+ */
76
+
68
77
  /**
69
78
  * @typedef FetchRefundModeConfigParam
70
79
  * @property {OrderPlatformModel.RefundModeConfigRequestPayload} body
@@ -528,6 +537,17 @@ class OrderPlatformValidator {
528
537
  }).required();
529
538
  }
530
539
 
540
+ /** @returns {FailedOrderLogsParam} */
541
+ static failedOrderLogs() {
542
+ return Joi.object({
543
+ applicationId: Joi.string().allow(""),
544
+ pageNo: Joi.number(),
545
+ pageSize: Joi.number(),
546
+ searchType: Joi.string().allow(""),
547
+ searchValue: Joi.string().allow(""),
548
+ }).required();
549
+ }
550
+
531
551
  /** @returns {FetchRefundModeConfigParam} */
532
552
  static fetchRefundModeConfig() {
533
553
  return Joi.object({
@@ -245,7 +245,7 @@ declare class Serviceability {
245
245
  * @summary: Get zones
246
246
  * @description: Retrieves a list of delivery zones. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getZones/).
247
247
  */
248
- getZones({ pageNo, pageSize, isActive, channelId, q, countryIsoCode, state, city, pincode, sector, requestHeaders, }?: ServiceabilityPlatformValidator.GetZonesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ListViewResponse>;
248
+ getZones({ pageNo, pageSize, isActive, applicationIds, q, countryIsoCode, state, city, pincode, sector, requestHeaders, }?: ServiceabilityPlatformValidator.GetZonesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ListViewResponse>;
249
249
  /**
250
250
  * @param {ServiceabilityPlatformValidator.UpdateCompanyConfigurationParam} arg
251
251
  * - Arg object