@gofynd/fdk-client-javascript 1.0.0 → 1.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (156) hide show
  1. package/documentation/application/CART.md +251 -251
  2. package/documentation/application/CATALOG.md +393 -393
  3. package/documentation/application/CONTENT.md +15 -1
  4. package/documentation/application/ORDER.md +268 -268
  5. package/documentation/application/PAYMENT.md +249 -249
  6. package/documentation/application/POSCART.md +297 -297
  7. package/documentation/platform/CART.md +499 -499
  8. package/documentation/platform/CATALOG.md +3497 -3097
  9. package/documentation/platform/COMPANYPROFILE.md +207 -207
  10. package/documentation/platform/CONTENT.md +123 -1
  11. package/documentation/platform/ORDER.md +1518 -1324
  12. package/documentation/platform/PARTNER.md +7 -7
  13. package/documentation/platform/PAYMENT.md +96 -96
  14. package/index.js +7 -1
  15. package/package.json +1 -1
  16. package/sdk/application/ApplicationConfig.js +1 -1
  17. package/sdk/application/Cart/CartApplicationClient.js +865 -52
  18. package/sdk/application/Cart/CartApplicationModel.d.ts +7 -7
  19. package/sdk/application/Cart/CartApplicationModel.js +335 -335
  20. package/sdk/application/Cart/CartApplicationValidator.js +1 -0
  21. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +1 -1
  22. package/sdk/application/Catalog/CatalogApplicationClient.js +1034 -60
  23. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +19 -19
  24. package/sdk/application/Catalog/CatalogApplicationModel.js +532 -532
  25. package/sdk/application/Catalog/CatalogApplicationValidator.js +1 -0
  26. package/sdk/application/Common/CommonApplicationClient.js +66 -4
  27. package/sdk/application/Common/CommonApplicationValidator.js +1 -0
  28. package/sdk/application/Communication/CommunicationApplicationClient.js +108 -6
  29. package/sdk/application/Communication/CommunicationApplicationValidator.js +1 -0
  30. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +1 -1
  31. package/sdk/application/Configuration/ConfigurationApplicationClient.js +558 -32
  32. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +1 -0
  33. package/sdk/application/Content/ContentApplicationClient.js +621 -38
  34. package/sdk/application/Content/ContentApplicationModel.d.ts +1 -0
  35. package/sdk/application/Content/ContentApplicationModel.js +11 -1
  36. package/sdk/application/Content/ContentApplicationValidator.js +1 -0
  37. package/sdk/application/FileStorage/FileStorageApplicationClient.js +101 -6
  38. package/sdk/application/FileStorage/FileStorageApplicationValidator.js +1 -0
  39. package/sdk/application/Lead/LeadApplicationClient.js +229 -14
  40. package/sdk/application/Lead/LeadApplicationValidator.js +1 -0
  41. package/sdk/application/Logistic/LogisticApplicationClient.js +134 -8
  42. package/sdk/application/Logistic/LogisticApplicationValidator.js +1 -0
  43. package/sdk/application/Order/OrderApplicationClient.d.ts +1 -1
  44. package/sdk/application/Order/OrderApplicationClient.js +403 -24
  45. package/sdk/application/Order/OrderApplicationModel.d.ts +20 -20
  46. package/sdk/application/Order/OrderApplicationModel.js +334 -334
  47. package/sdk/application/Order/OrderApplicationValidator.js +1 -0
  48. package/sdk/application/Payment/PaymentApplicationClient.js +1381 -78
  49. package/sdk/application/Payment/PaymentApplicationModel.d.ts +2 -2
  50. package/sdk/application/Payment/PaymentApplicationModel.js +350 -350
  51. package/sdk/application/Payment/PaymentApplicationValidator.js +1 -0
  52. package/sdk/application/PosCart/PosCartApplicationClient.js +914 -54
  53. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +15 -15
  54. package/sdk/application/PosCart/PosCartApplicationModel.js +389 -389
  55. package/sdk/application/PosCart/PosCartApplicationValidator.js +1 -0
  56. package/sdk/application/Rewards/RewardsApplicationClient.js +235 -14
  57. package/sdk/application/Rewards/RewardsApplicationValidator.js +1 -0
  58. package/sdk/application/Share/ShareApplicationClient.js +226 -14
  59. package/sdk/application/Share/ShareApplicationValidator.js +1 -0
  60. package/sdk/application/Theme/ThemeApplicationClient.js +130 -8
  61. package/sdk/application/Theme/ThemeApplicationValidator.js +1 -0
  62. package/sdk/application/User/UserApplicationClient.js +1133 -70
  63. package/sdk/application/User/UserApplicationValidator.js +1 -0
  64. package/sdk/common/AxiosHelper.js +1 -1
  65. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +16 -8
  66. package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +287 -16
  67. package/sdk/platform/Analytics/AnalyticsPlatformClient.d.ts +8 -4
  68. package/sdk/platform/Analytics/AnalyticsPlatformClient.js +153 -8
  69. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -4
  70. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +141 -8
  71. package/sdk/platform/Billing/BillingPlatformClient.d.ts +24 -12
  72. package/sdk/platform/Billing/BillingPlatformClient.js +429 -24
  73. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +34 -17
  74. package/sdk/platform/Cart/CartPlatformApplicationClient.js +617 -34
  75. package/sdk/platform/Cart/CartPlatformModel.d.ts +35 -35
  76. package/sdk/platform/Cart/CartPlatformModel.js +617 -617
  77. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +191 -138
  78. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +2202 -302
  79. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +11 -11
  80. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +45 -45
  81. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +344 -226
  82. package/sdk/platform/Catalog/CatalogPlatformClient.js +3282 -488
  83. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +110 -100
  84. package/sdk/platform/Catalog/CatalogPlatformModel.js +2073 -1795
  85. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +23 -21
  86. package/sdk/platform/Catalog/CatalogPlatformValidator.js +103 -84
  87. package/sdk/platform/Common/CommonPlatformClient.d.ts +4 -2
  88. package/sdk/platform/Common/CommonPlatformClient.js +73 -4
  89. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +80 -40
  90. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +1499 -80
  91. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -1
  92. package/sdk/platform/Communication/CommunicationPlatformClient.js +41 -2
  93. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +27 -14
  94. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +486 -26
  95. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +9 -9
  96. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +274 -274
  97. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +56 -28
  98. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +1022 -56
  99. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +36 -18
  100. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +693 -36
  101. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +148 -67
  102. package/sdk/platform/Content/ContentPlatformApplicationClient.js +2446 -140
  103. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -0
  104. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +7 -0
  105. package/sdk/platform/Content/ContentPlatformModel.d.ts +4 -0
  106. package/sdk/platform/Content/ContentPlatformModel.js +43 -1
  107. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +21 -10
  108. package/sdk/platform/Discount/DiscountPlatformClient.js +400 -22
  109. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +8 -4
  110. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +148 -8
  111. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +12 -6
  112. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +214 -12
  113. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +27 -14
  114. package/sdk/platform/Inventory/InventoryPlatformClient.js +449 -24
  115. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +26 -13
  116. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +447 -26
  117. package/sdk/platform/Lead/LeadPlatformClient.d.ts +22 -11
  118. package/sdk/platform/Lead/LeadPlatformClient.js +384 -22
  119. package/sdk/platform/OAuthClient.js +8 -8
  120. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +6 -3
  121. package/sdk/platform/Order/OrderPlatformApplicationClient.js +125 -6
  122. package/sdk/platform/Order/OrderPlatformClient.d.ts +108 -47
  123. package/sdk/platform/Order/OrderPlatformClient.js +1641 -100
  124. package/sdk/platform/Order/OrderPlatformModel.d.ts +69 -58
  125. package/sdk/platform/Order/OrderPlatformModel.js +1485 -1493
  126. package/sdk/platform/Order/OrderPlatformValidator.d.ts +2 -1
  127. package/sdk/platform/Order/OrderPlatformValidator.js +15 -4
  128. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -2
  129. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +74 -4
  130. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -1
  131. package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
  132. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +22 -11
  133. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +418 -22
  134. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +21 -11
  135. package/sdk/platform/Payment/PaymentPlatformClient.js +374 -20
  136. package/sdk/platform/Payment/PaymentPlatformModel.js +139 -139
  137. package/sdk/platform/PlatformApplicationClient.d.ts +2973 -2827
  138. package/sdk/platform/PlatformApplicationClient.js +3461 -3263
  139. package/sdk/platform/PlatformClient.d.ts +2973 -2827
  140. package/sdk/platform/PlatformClient.js +3461 -3263
  141. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +26 -13
  142. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +449 -26
  143. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +8 -4
  144. package/sdk/platform/Share/SharePlatformApplicationClient.js +139 -8
  145. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +47 -23
  146. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +816 -48
  147. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +24 -12
  148. package/sdk/platform/User/UserPlatformApplicationClient.js +417 -24
  149. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +12 -6
  150. package/sdk/platform/Webhook/WebhookPlatformClient.js +229 -12
  151. package/sdk/public/Configuration/ConfigurationPublicClient.js +72 -4
  152. package/sdk/public/Configuration/ConfigurationPublicValidator.js +3 -1
  153. package/sdk/public/Inventory/InventoryPublicClient.js +210 -12
  154. package/sdk/public/Inventory/InventoryPublicValidator.js +3 -1
  155. package/sdk/public/Webhook/WebhookPublicClient.js +74 -4
  156. package/sdk/public/Webhook/WebhookPublicValidator.js +3 -1
@@ -5,94 +5,104 @@ declare class Payment {
5
5
  /**
6
6
  * @param {Object} arg - Arg object.
7
7
  * @param {string} [arg.uniqueExternalId] - Fetch payouts using unique external id
8
+ * @returns {Promise<PayoutsResponse>} - Success response
8
9
  * @summary: Get All Payouts
9
10
  * @description: Get All Payouts
10
11
  */
11
12
  getAllPayouts({ uniqueExternalId }?: {
12
13
  uniqueExternalId?: string;
13
- }): Promise<any>;
14
+ }): Promise<PayoutsResponse>;
14
15
  /**
15
16
  * @param {Object} arg - Arg object.
16
17
  * @param {PayoutRequest} arg.body
18
+ * @returns {Promise<PayoutResponse>} - Success response
17
19
  * @summary: Save Payout
18
20
  * @description: Save Payout
19
21
  */
20
22
  savePayout({ body }?: {
21
23
  body: PayoutRequest;
22
- }): Promise<any>;
24
+ }): Promise<PayoutResponse>;
23
25
  /**
24
26
  * @param {Object} arg - Arg object.
25
27
  * @param {string} arg.uniqueTransferNo - Unique transfer id
26
28
  * @param {PayoutRequest} arg.body
29
+ * @returns {Promise<UpdatePayoutResponse>} - Success response
27
30
  * @summary: Update Payout
28
31
  * @description: Update Payout
29
32
  */
30
33
  updatePayout({ uniqueTransferNo, body }?: {
31
34
  uniqueTransferNo: string;
32
35
  body: PayoutRequest;
33
- }): Promise<any>;
36
+ }): Promise<UpdatePayoutResponse>;
34
37
  /**
35
38
  * @param {Object} arg - Arg object.
36
39
  * @param {string} arg.uniqueTransferNo - Unique transfer id
37
40
  * @param {UpdatePayoutRequest} arg.body
41
+ * @returns {Promise<UpdatePayoutResponse>} - Success response
38
42
  * @summary: Partial Update Payout
39
43
  * @description: Partial Update Payout
40
44
  */
41
45
  activateAndDectivatePayout({ uniqueTransferNo, body }?: {
42
46
  uniqueTransferNo: string;
43
47
  body: UpdatePayoutRequest;
44
- }): Promise<any>;
48
+ }): Promise<UpdatePayoutResponse>;
45
49
  /**
46
50
  * @param {Object} arg - Arg object.
47
51
  * @param {string} arg.uniqueTransferNo - Unique transfer id
52
+ * @returns {Promise<DeletePayoutResponse>} - Success response
48
53
  * @summary: Delete Payout
49
54
  * @description: Delete Payout
50
55
  */
51
56
  deletePayout({ uniqueTransferNo }?: {
52
57
  uniqueTransferNo: string;
53
- }): Promise<any>;
58
+ }): Promise<DeletePayoutResponse>;
54
59
  /**
55
60
  * @param {Object} arg - Arg object.
56
61
  * @param {string} [arg.uniqueExternalId] - Unique external id
62
+ * @returns {Promise<SubscriptionPaymentMethodResponse>} - Success response
57
63
  * @summary: List Subscription Payment Method
58
64
  * @description: Get all Subscription Payment Method
59
65
  */
60
66
  getSubscriptionPaymentMethod({ uniqueExternalId }?: {
61
67
  uniqueExternalId?: string;
62
- }): Promise<any>;
68
+ }): Promise<SubscriptionPaymentMethodResponse>;
63
69
  /**
64
70
  * @param {Object} arg - Arg object.
65
71
  * @param {string} arg.uniqueExternalId -
66
72
  * @param {string} arg.paymentMethodId -
73
+ * @returns {Promise<DeleteSubscriptionPaymentMethodResponse>} - Success response
67
74
  * @summary: Delete Subscription Payment Method
68
75
  * @description: Uses this api to Delete Subscription Payment Method
69
76
  */
70
- deleteSubscriptionPaymentMethod({ uniqueExternalId, paymentMethodId }?: {
77
+ deleteSubscriptionPaymentMethod({ uniqueExternalId, paymentMethodId, }?: {
71
78
  uniqueExternalId: string;
72
79
  paymentMethodId: string;
73
- }): Promise<any>;
80
+ }): Promise<DeleteSubscriptionPaymentMethodResponse>;
74
81
  /**
75
82
  * @param {Object} arg - Arg object.
83
+ * @returns {Promise<SubscriptionConfigResponse>} - Success response
76
84
  * @summary: List Subscription Config
77
85
  * @description: Get all Subscription Config details
78
86
  */
79
- getSubscriptionConfig({}?: any): Promise<any>;
87
+ getSubscriptionConfig({}?: any): Promise<SubscriptionConfigResponse>;
80
88
  /**
81
89
  * @param {Object} arg - Arg object.
82
90
  * @param {SaveSubscriptionSetupIntentRequest} arg.body
91
+ * @returns {Promise<SaveSubscriptionSetupIntentResponse>} - Success response
83
92
  * @summary: Save Subscription Setup Intent
84
93
  * @description: Uses this api to Save Subscription Setup Intent
85
94
  */
86
95
  saveSubscriptionSetupIntent({ body }?: {
87
96
  body: SaveSubscriptionSetupIntentRequest;
88
- }): Promise<any>;
97
+ }): Promise<SaveSubscriptionSetupIntentResponse>;
89
98
  /**
90
99
  * @param {Object} arg - Arg object.
91
100
  * @param {string} [arg.ifscCode] -
101
+ * @returns {Promise<IfscCodeResponse>} - Success response
92
102
  * @summary: Ifsc Code Verification
93
103
  * @description: Get True/False for correct IFSC Code for adding bank details for refund
94
104
  */
95
105
  verifyIfscCode({ ifscCode }?: {
96
106
  ifscCode?: string;
97
- }): Promise<any>;
107
+ }): Promise<IfscCodeResponse>;
98
108
  }