@gofynd/fdk-client-javascript 1.4.2-beta.7 → 1.4.4

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 (254) hide show
  1. package/README.md +1 -10
  2. package/application.d.ts +3 -3
  3. package/common.d.ts +3 -3
  4. package/index.d.ts +15 -15
  5. package/package.json +5 -3
  6. package/partner.d.ts +3 -3
  7. package/platform.d.ts +3 -3
  8. package/public.d.ts +2 -2
  9. package/sdk/application/ApplicationAPIClient.d.ts +1 -1
  10. package/sdk/application/ApplicationAPIClient.js +0 -1
  11. package/sdk/application/ApplicationClient.d.ts +17 -17
  12. package/sdk/application/ApplicationConfig.d.ts +3 -3
  13. package/sdk/application/Cart/CartApplicationClient.d.ts +58 -58
  14. package/sdk/application/Cart/CartApplicationClient.js +56 -56
  15. package/sdk/application/Cart/CartApplicationValidator.d.ts +1 -1
  16. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +72 -72
  17. package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
  18. package/sdk/application/Common/CommonApplicationClient.d.ts +6 -6
  19. package/sdk/application/Common/CommonApplicationClient.js +4 -4
  20. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +8 -8
  21. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
  22. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
  23. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +34 -34
  24. package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
  25. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +1 -1
  26. package/sdk/application/Content/ContentApplicationClient.d.ts +48 -48
  27. package/sdk/application/Content/ContentApplicationClient.js +45 -45
  28. package/sdk/application/Content/ContentApplicationModel.d.ts +18 -18
  29. package/sdk/application/Content/ContentApplicationModel.js +26 -26
  30. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +7 -7
  31. package/sdk/application/FileStorage/FileStorageApplicationClient.js +15 -9
  32. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
  33. package/sdk/application/Lead/LeadApplicationClient.d.ts +12 -12
  34. package/sdk/application/Lead/LeadApplicationClient.js +10 -10
  35. package/sdk/application/Lead/LeadApplicationModel.d.ts +64 -77
  36. package/sdk/application/Lead/LeadApplicationModel.js +42 -52
  37. package/sdk/application/Lead/LeadApplicationValidator.d.ts +1 -1
  38. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +24 -24
  39. package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
  40. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +1 -1
  41. package/sdk/application/Order/OrderApplicationClient.d.ts +19 -30
  42. package/sdk/application/Order/OrderApplicationClient.js +17 -97
  43. package/sdk/application/Order/OrderApplicationValidator.d.ts +2 -16
  44. package/sdk/application/Order/OrderApplicationValidator.js +0 -13
  45. package/sdk/application/Payment/PaymentApplicationClient.d.ts +91 -91
  46. package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
  47. package/sdk/application/Payment/PaymentApplicationModel.d.ts +5 -2
  48. package/sdk/application/Payment/PaymentApplicationModel.js +4 -2
  49. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +6 -6
  50. package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
  51. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +29 -29
  52. package/sdk/application/PosCart/PosCartApplicationClient.js +27 -27
  53. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +1 -1
  54. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +9 -9
  55. package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
  56. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +1 -1
  57. package/sdk/application/Share/ShareApplicationClient.d.ts +9 -9
  58. package/sdk/application/Share/ShareApplicationClient.js +7 -7
  59. package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
  60. package/sdk/application/Share/ShareApplicationModel.js +2 -0
  61. package/sdk/application/Share/ShareApplicationValidator.d.ts +1 -1
  62. package/sdk/application/Theme/ThemeApplicationClient.d.ts +10 -10
  63. package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
  64. package/sdk/application/Theme/ThemeApplicationModel.d.ts +25 -32
  65. package/sdk/application/Theme/ThemeApplicationModel.js +30 -40
  66. package/sdk/application/User/UserApplicationClient.d.ts +76 -76
  67. package/sdk/application/User/UserApplicationClient.js +74 -74
  68. package/sdk/application/User/UserApplicationModel.d.ts +44 -13
  69. package/sdk/application/User/UserApplicationModel.js +17 -13
  70. package/sdk/application/User/UserApplicationValidator.d.ts +1 -1
  71. package/sdk/application/index.d.ts +18 -18
  72. package/sdk/common/AxiosHelper.d.ts +1 -1
  73. package/sdk/common/AxiosHelper.js +38 -17
  74. package/sdk/common/Clickstream.js +22 -16
  75. package/sdk/common/curlHelper.js +1 -3
  76. package/sdk/common/utils.d.ts +15 -0
  77. package/sdk/common/utils.js +30 -0
  78. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +3 -3
  79. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +2 -2
  80. package/sdk/partner/Lead/LeadPartnerClient.d.ts +3 -3
  81. package/sdk/partner/Lead/LeadPartnerClient.js +1 -1
  82. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +5 -5
  83. package/sdk/partner/Logistics/LogisticsPartnerClient.js +4 -4
  84. package/sdk/partner/OAuthClient.d.ts +4 -4
  85. package/sdk/partner/PartnerAPIClient.d.ts +1 -1
  86. package/sdk/partner/PartnerAPIClient.js +0 -1
  87. package/sdk/partner/PartnerClient.d.ts +6 -6
  88. package/sdk/partner/PartnerConfig.d.ts +4 -4
  89. package/sdk/partner/Theme/ThemePartnerClient.d.ts +20 -20
  90. package/sdk/partner/Theme/ThemePartnerClient.js +19 -19
  91. package/sdk/partner/Theme/ThemePartnerModel.d.ts +25 -32
  92. package/sdk/partner/Theme/ThemePartnerModel.js +30 -40
  93. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +3 -3
  94. package/sdk/partner/Webhook/WebhookPartnerClient.js +2 -2
  95. package/sdk/partner/index.d.ts +7 -7
  96. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
  97. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +6 -6
  98. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
  99. package/sdk/platform/Billing/BillingPlatformClient.d.ts +25 -25
  100. package/sdk/platform/Billing/BillingPlatformClient.js +23 -23
  101. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +1 -1
  102. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +115 -115
  103. package/sdk/platform/Cart/CartPlatformApplicationClient.js +113 -113
  104. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +1 -1
  105. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +147 -146
  106. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +146 -145
  107. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1 -1
  108. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +156 -156
  109. package/sdk/platform/Catalog/CatalogPlatformClient.js +153 -153
  110. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +65 -28
  111. package/sdk/platform/Catalog/CatalogPlatformModel.js +68 -36
  112. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1 -1
  113. package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -5
  114. package/sdk/platform/Common/CommonPlatformClient.js +3 -3
  115. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +133 -133
  116. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +131 -131
  117. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +1 -1
  118. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +4 -4
  119. package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -2
  120. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +12 -0
  121. package/sdk/platform/Communication/CommunicationPlatformModel.js +12 -0
  122. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +28 -28
  123. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +25 -25
  124. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -0
  125. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +2 -0
  126. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +1 -1
  127. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -52
  128. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +50 -50
  129. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +1 -1
  130. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +31 -31
  131. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +29 -29
  132. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +1 -1
  133. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +128 -128
  134. package/sdk/platform/Content/ContentPlatformApplicationClient.js +131 -131
  135. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +5 -5
  136. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
  137. package/sdk/platform/Content/ContentPlatformClient.d.ts +33 -33
  138. package/sdk/platform/Content/ContentPlatformClient.js +37 -37
  139. package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -18
  140. package/sdk/platform/Content/ContentPlatformModel.js +26 -26
  141. package/sdk/platform/Content/ContentPlatformValidator.d.ts +5 -5
  142. package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
  143. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +24 -24
  144. package/sdk/platform/Discount/DiscountPlatformClient.js +22 -22
  145. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +1 -1
  146. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +24 -23
  147. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +32 -25
  148. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
  149. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +15 -15
  150. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +28 -19
  151. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +12 -1
  152. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +16 -2
  153. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +1 -1
  154. package/sdk/platform/Finance/FinancePlatformClient.d.ts +30 -30
  155. package/sdk/platform/Finance/FinancePlatformClient.js +28 -28
  156. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +1 -1
  157. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +19 -19
  158. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +17 -17
  159. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +1 -1
  160. package/sdk/platform/Lead/LeadPlatformClient.d.ts +20 -20
  161. package/sdk/platform/Lead/LeadPlatformClient.js +18 -18
  162. package/sdk/platform/Lead/LeadPlatformModel.d.ts +62 -77
  163. package/sdk/platform/Lead/LeadPlatformModel.js +40 -52
  164. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +1 -1
  165. package/sdk/platform/OAuthClient.d.ts +3 -3
  166. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +12 -12
  167. package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
  168. package/sdk/platform/Order/OrderPlatformClient.d.ts +111 -122
  169. package/sdk/platform/Order/OrderPlatformClient.js +109 -204
  170. package/sdk/platform/Order/OrderPlatformModel.d.ts +18 -2
  171. package/sdk/platform/Order/OrderPlatformModel.js +12 -2
  172. package/sdk/platform/Order/OrderPlatformValidator.d.ts +2 -34
  173. package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
  174. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -6
  175. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
  176. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -1
  177. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +97 -97
  178. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +95 -95
  179. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +1 -1
  180. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +13 -13
  181. package/sdk/platform/Payment/PaymentPlatformClient.js +11 -11
  182. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
  183. package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
  184. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +1 -1
  185. package/sdk/platform/PlatformAPIClient.d.ts +1 -1
  186. package/sdk/platform/PlatformAPIClient.js +0 -1
  187. package/sdk/platform/PlatformApplicationClient.d.ts +16 -16
  188. package/sdk/platform/PlatformClient.d.ts +19 -21
  189. package/sdk/platform/PlatformClient.js +0 -4
  190. package/sdk/platform/PlatformConfig.d.ts +4 -4
  191. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +14 -14
  192. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
  193. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +1 -1
  194. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +42 -42
  195. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
  196. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +1 -1
  197. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +55 -54
  198. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +53 -52
  199. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +2 -2
  200. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -2
  201. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +1 -1
  202. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +7 -7
  203. package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
  204. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
  205. package/sdk/platform/Share/SharePlatformModel.d.ts +4 -0
  206. package/sdk/platform/Share/SharePlatformModel.js +4 -0
  207. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +42 -112
  208. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +40 -597
  209. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +2 -101
  210. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
  211. package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -8
  212. package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
  213. package/sdk/platform/Theme/ThemePlatformModel.d.ts +25 -32
  214. package/sdk/platform/Theme/ThemePlatformModel.js +30 -40
  215. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +1 -1
  216. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +37 -37
  217. package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
  218. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +1 -1
  219. package/sdk/platform/User/UserPlatformModel.d.ts +48 -13
  220. package/sdk/platform/User/UserPlatformModel.js +21 -13
  221. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +20 -19
  222. package/sdk/platform/Webhook/WebhookPlatformClient.js +18 -17
  223. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
  224. package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
  225. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +1 -1
  226. package/sdk/platform/index.d.ts +24 -25
  227. package/sdk/platform/index.js +0 -2
  228. package/sdk/public/Billing/BillingPublicClient.d.ts +3 -3
  229. package/sdk/public/Billing/BillingPublicClient.js +4 -4
  230. package/sdk/public/Billing/BillingPublicValidator.d.ts +2 -2
  231. package/sdk/public/Billing/BillingPublicValidator.js +2 -2
  232. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -3
  233. package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -1
  234. package/sdk/public/Content/ContentPublicClient.d.ts +2 -2
  235. package/sdk/public/Content/ContentPublicValidator.d.ts +2 -2
  236. package/sdk/public/Content/ContentPublicValidator.js +3 -3
  237. package/sdk/public/Inventory/InventoryPublicClient.d.ts +2 -2
  238. package/sdk/public/Inventory/InventoryPublicModel.d.ts +8 -8
  239. package/sdk/public/Inventory/InventoryPublicModel.js +8 -8
  240. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +1 -1
  241. package/sdk/public/Partner/PartnerPublicClient.d.ts +3 -3
  242. package/sdk/public/Partner/PartnerPublicClient.js +1 -1
  243. package/sdk/public/PublicAPIClient.d.ts +1 -1
  244. package/sdk/public/PublicClient.d.ts +7 -7
  245. package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
  246. package/sdk/public/Webhook/WebhookPublicClient.js +2 -2
  247. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +1 -1
  248. package/sdk/public/index.d.ts +8 -8
  249. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +0 -152
  250. package/sdk/platform/Inventory/InventoryPlatformClient.js +0 -1017
  251. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +0 -1355
  252. package/sdk/platform/Inventory/InventoryPlatformModel.js +0 -1544
  253. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +0 -171
  254. package/sdk/platform/Inventory/InventoryPlatformValidator.js +0 -159
@@ -9,7 +9,7 @@ declare class Finance {
9
9
  * @returns {Promise<FinancePlatformModel.ChannelDisplayNameResponse>} -
10
10
  * Success response
11
11
  * @name channelDisplayName
12
- * @summary: Get channel display name.
12
+ * @summary: Get channel display name
13
13
  * @description: Retrieve the display name for a channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/channelDisplayName/).
14
14
  */
15
15
  channelDisplayName({ filterKey, requestHeaders }?: FinancePlatformValidator.ChannelDisplayNameParam, { responseHeaders }?: object): Promise<FinancePlatformModel.ChannelDisplayNameResponse>;
@@ -23,7 +23,7 @@ declare class Finance {
23
23
  * - Success response
24
24
  *
25
25
  * @name createSellerCreditNoteConfig
26
- * @summary: Create seller credit note config.
26
+ * @summary: Create seller credit note config
27
27
  * @description: Set up configuration for seller credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/createSellerCreditNoteConfig/).
28
28
  */
29
29
  createSellerCreditNoteConfig({ body, requestHeaders }?: FinancePlatformValidator.CreateSellerCreditNoteConfigParam, { responseHeaders }?: object): Promise<FinancePlatformModel.CreateSellerCreditNoteConfigResponse>;
@@ -34,7 +34,7 @@ declare class Finance {
34
34
  * @returns {Promise<FinancePlatformModel.CreditNoteDetailsResponse>} -
35
35
  * Success response
36
36
  * @name creditNoteDetails
37
- * @summary: Get credit note details.
37
+ * @summary: Get credit note details
38
38
  * @description: Retrieve detailed information about a credit note. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/creditNoteDetails/).
39
39
  */
40
40
  creditNoteDetails({ body, requestHeaders }?: FinancePlatformValidator.CreditNoteDetailsParam, { responseHeaders }?: object): Promise<FinancePlatformModel.CreditNoteDetailsResponse>;
@@ -46,7 +46,7 @@ declare class Finance {
46
46
  * - Success response
47
47
  *
48
48
  * @name creditlineDataplatform
49
- * @summary: Access credit line data platform.
49
+ * @summary: Access credit line data platform
50
50
  * @description: Connect to the credit line data platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/creditlineDataplatform/).
51
51
  */
52
52
  creditlineDataplatform({ body, requestHeaders }?: FinancePlatformValidator.CreditlineDataplatformParam, { responseHeaders }?: object): Promise<FinancePlatformModel.CreditlineDataPlatformResponse>;
@@ -56,7 +56,7 @@ declare class Finance {
56
56
  * @param {import("../PlatformAPIClient").Options} - Options
57
57
  * @returns {Promise<FinancePlatformModel.DeleteConfigResponse>} - Success response
58
58
  * @name deleteConfig
59
- * @summary: Deletes credit note config.
59
+ * @summary: Deletes credit note config
60
60
  * @description: Deletes credit note config. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/deleteConfig/).
61
61
  */
62
62
  deleteConfig({ body, requestHeaders }?: FinancePlatformValidator.DeleteConfigParam, { responseHeaders }?: object): Promise<FinancePlatformModel.DeleteConfigResponse>;
@@ -68,7 +68,7 @@ declare class Finance {
68
68
  * - Success response
69
69
  *
70
70
  * @name downloadCreditDebitNote
71
- * @summary: Download credit/debit note.
71
+ * @summary: Download credit/debit note
72
72
  * @description: Retrieve and save credit/debit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/downloadCreditDebitNote/).
73
73
  */
74
74
  downloadCreditDebitNote({ body, requestHeaders }?: FinancePlatformValidator.DownloadCreditDebitNoteParam, { responseHeaders }?: object): Promise<FinancePlatformModel.DownloadCreditDebitNoteResponse>;
@@ -78,7 +78,7 @@ declare class Finance {
78
78
  * @param {import("../PlatformAPIClient").Options} - Options
79
79
  * @returns {Promise<FinancePlatformModel.DownloadReportList>} - Success response
80
80
  * @name downloadReport
81
- * @summary: Download financial report.
81
+ * @summary: Download financial report
82
82
  * @description: Retrieve and save a financial report. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/downloadReport/).
83
83
  */
84
84
  downloadReport({ body, requestHeaders }?: FinancePlatformValidator.DownloadReportParam, { responseHeaders }?: object): Promise<FinancePlatformModel.DownloadReportList>;
@@ -90,7 +90,7 @@ declare class Finance {
90
90
  * - Success response
91
91
  *
92
92
  * @name downloadReportCustomerCn
93
- * @summary: Download customer credit note report.
93
+ * @summary: Download customer credit note report
94
94
  * @description: Retrieve and save a report for customer credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/downloadReportCustomerCn/).
95
95
  */
96
96
  downloadReportCustomerCn({ body, requestHeaders }?: FinancePlatformValidator.DownloadReportCustomerCnParam, { responseHeaders }?: object): Promise<FinancePlatformModel.DownloadReportCustomerCnResponse>;
@@ -100,7 +100,7 @@ declare class Finance {
100
100
  * @param {import("../PlatformAPIClient").Options} - Options
101
101
  * @returns {Promise<FinancePlatformModel.GenerateReportJson>} - Success response
102
102
  * @name generateReport
103
- * @summary: Generate financial report.
103
+ * @summary: Generate financial report
104
104
  * @description: Create a financial report with relevant data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/generateReport/).
105
105
  */
106
106
  generateReport({ body, requestHeaders }?: FinancePlatformValidator.GenerateReportParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GenerateReportJson>;
@@ -112,7 +112,7 @@ declare class Finance {
112
112
  * - Success response
113
113
  *
114
114
  * @name generateReportCustomerCn
115
- * @summary: Generate customer credit note report.
115
+ * @summary: Generate customer credit note report
116
116
  * @description: Create a report specifically for customer credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/generateReportCustomerCn/).
117
117
  */
118
118
  generateReportCustomerCn({ body, requestHeaders }?: FinancePlatformValidator.GenerateReportCustomerCnParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GenerateReportCustomerCnResponse>;
@@ -122,7 +122,7 @@ declare class Finance {
122
122
  * @param {import("../PlatformAPIClient").Options} - Options
123
123
  * @returns {Promise<FinancePlatformModel.GetAffiliateResponse>} - Success response
124
124
  * @name getAffiliate
125
- * @summary: Get affiliate details.
125
+ * @summary: Get affiliate details
126
126
  * @description: Retrieve information about an affiliate. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getAffiliate/).
127
127
  */
128
128
  getAffiliate({ body, requestHeaders }?: FinancePlatformValidator.GetAffiliateParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetAffiliateResponse>;
@@ -132,7 +132,7 @@ declare class Finance {
132
132
  * @param {import("../PlatformAPIClient").Options} - Options
133
133
  * @returns {Promise<FinancePlatformModel.GetCnConfigResponse>} - Success response
134
134
  * @name getCnConfig
135
- * @summary: Get credit note configuration.
135
+ * @summary: Get credit note configuration
136
136
  * @description: Retrieve configuration settings for credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getCnConfig/).
137
137
  */
138
138
  getCnConfig({ body, requestHeaders }?: FinancePlatformValidator.GetCnConfigParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetCnConfigResponse>;
@@ -144,7 +144,7 @@ declare class Finance {
144
144
  * - Success response
145
145
  *
146
146
  * @name getCustomerCreditBalance
147
- * @summary: Get customer credit balance.
147
+ * @summary: Get customer credit balance
148
148
  * @description: Retrieve the credit balance of a customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getCustomerCreditBalance/).
149
149
  */
150
150
  getCustomerCreditBalance({ body, requestHeaders }?: FinancePlatformValidator.GetCustomerCreditBalanceParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetCustomerCreditBalanceResponse>;
@@ -154,7 +154,7 @@ declare class Finance {
154
154
  * @param {import("../PlatformAPIClient").Options} - Options
155
155
  * @returns {Promise<FinancePlatformModel.GetEngineResponse>} - Success response
156
156
  * @name getData
157
- * @summary: Get financial data.
157
+ * @summary: Get financial data
158
158
  * @description: Retrieve financial data for analysis. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getData/).
159
159
  */
160
160
  getData({ body, requestHeaders }?: FinancePlatformValidator.GetDataParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetEngineResponse>;
@@ -164,7 +164,7 @@ declare class Finance {
164
164
  * @param {import("../PlatformAPIClient").Options} - Options
165
165
  * @returns {Promise<FinancePlatformModel.GetPdfUrlViewResponse>} - Success response
166
166
  * @name getPdfUrlView
167
- * @summary: Get PDF URL view.
167
+ * @summary: Get PDF URL view
168
168
  * @description: Retrieve a URL to view a PDF document. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getPdfUrlView/).
169
169
  */
170
170
  getPdfUrlView({ body, requestHeaders }?: FinancePlatformValidator.GetPdfUrlViewParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetPdfUrlViewResponse>;
@@ -174,7 +174,7 @@ declare class Finance {
174
174
  * @param {import("../PlatformAPIClient").Options} - Options
175
175
  * @returns {Promise<FinancePlatformModel.GetReasonResponse>} - Success response
176
176
  * @name getReason
177
- * @summary: Get transaction reason.
177
+ * @summary: Get transaction reason
178
178
  * @description: Retrieve the reason behind a transaction. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getReason/).
179
179
  */
180
180
  getReason({ body, requestHeaders }?: FinancePlatformValidator.GetReasonParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetReasonResponse>;
@@ -184,7 +184,7 @@ declare class Finance {
184
184
  * @param {import("../PlatformAPIClient").Options} - Options
185
185
  * @returns {Promise<FinancePlatformModel.GetReportListResponse>} - Success response
186
186
  * @name getReportList
187
- * @summary: Get report list.
187
+ * @summary: Get report list
188
188
  * @description: Retrieve a list of available financial reports. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getReportList/).
189
189
  */
190
190
  getReportList({ body, requestHeaders }?: FinancePlatformValidator.GetReportListParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetReportListResponse>;
@@ -195,7 +195,7 @@ declare class Finance {
195
195
  * @returns {Promise<FinancePlatformModel.GetReportingFiltersResponse>} -
196
196
  * Success response
197
197
  * @name getReportingFilters
198
- * @summary: Get reporting filters.
198
+ * @summary: Get reporting filters
199
199
  * @description: Retrieve available filters for financial reporting. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getReportingFilters/).
200
200
  */
201
201
  getReportingFilters({ filterKey, affiliateId, requestHeaders }?: FinancePlatformValidator.GetReportingFiltersParam, { responseHeaders }?: object): Promise<FinancePlatformModel.GetReportingFiltersResponse>;
@@ -206,7 +206,7 @@ declare class Finance {
206
206
  * @returns {Promise<FinancePlatformModel.InvoiceActivityLogsResponse>} -
207
207
  * Success response
208
208
  * @name invoiceActivityLogs
209
- * @summary: Display activity log details of an invoice.
209
+ * @summary: Display activity log details of an invoice
210
210
  * @description: Display activity log details of invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceActivityLogs/).
211
211
  */
212
212
  invoiceActivityLogs({ invoiceNumber, requestHeaders }?: FinancePlatformValidator.InvoiceActivityLogsParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoiceActivityLogsResponse>;
@@ -216,8 +216,8 @@ declare class Finance {
216
216
  * @param {import("../PlatformAPIClient").Options} - Options
217
217
  * @returns {Promise<FinancePlatformModel.InvoiceListingResponse>} - Success response
218
218
  * @name invoiceListing
219
- * @summary: Gives list of invoices.
220
- * @description: Gives list of invoices. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceListing/).
219
+ * @summary: List invoices
220
+ * @description: Provides list of invoices generated for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceListing/).
221
221
  */
222
222
  invoiceListing({ body, requestHeaders }?: FinancePlatformValidator.InvoiceListingParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoiceListingResponse>;
223
223
  /**
@@ -226,7 +226,7 @@ declare class Finance {
226
226
  * @param {import("../PlatformAPIClient").Options} - Options
227
227
  * @returns {Promise<FinancePlatformModel.InvoicePdfResponse>} - Success response
228
228
  * @name invoicePDF
229
- * @summary: Get invoice PDF.
229
+ * @summary: Get invoice PDF
230
230
  * @description: Retrieve the PDF version of an invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoicePDF/).
231
231
  */
232
232
  invoicePDF({ body, requestHeaders }?: FinancePlatformValidator.InvoicePDFParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoicePdfResponse>;
@@ -237,7 +237,7 @@ declare class Finance {
237
237
  * @returns {Promise<FinancePlatformModel.InvoicePaymentDetailsResponse>} -
238
238
  * Success response
239
239
  * @name invoicePaymentDetails
240
- * @summary: Display payment details of an invoice.
240
+ * @summary: Display payment details of an invoice
241
241
  * @description: Display payment details of invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoicePaymentDetails/).
242
242
  */
243
243
  invoicePaymentDetails({ invoiceNumber, requestHeaders }?: FinancePlatformValidator.InvoicePaymentDetailsParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoicePaymentDetailsResponse>;
@@ -247,7 +247,7 @@ declare class Finance {
247
247
  * @param {import("../PlatformAPIClient").Options} - Options
248
248
  * @returns {Promise<FinancePlatformModel.InvoiceTypeResponse>} - Success response
249
249
  * @name invoiceType
250
- * @summary: Get invoice types.
250
+ * @summary: Get invoice types
251
251
  * @description: Retrieve a list of available invoice types. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceType/).
252
252
  */
253
253
  invoiceType({ body, requestHeaders }?: FinancePlatformValidator.InvoiceTypeParam, { responseHeaders }?: object): Promise<FinancePlatformModel.InvoiceTypeResponse>;
@@ -258,7 +258,7 @@ declare class Finance {
258
258
  * @returns {Promise<FinancePlatformModel.IsCnRefundMethodResponse>} -
259
259
  * Success response
260
260
  * @name isCnRefundMethod
261
- * @summary: Check CN refund method.
261
+ * @summary: Check refund method
262
262
  * @description: Verify the refund method for credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/isCnRefundMethod/).
263
263
  */
264
264
  isCnRefundMethod({ body, requestHeaders }?: FinancePlatformValidator.IsCnRefundMethodParam, { responseHeaders }?: object): Promise<FinancePlatformModel.IsCnRefundMethodResponse>;
@@ -269,7 +269,7 @@ declare class Finance {
269
269
  * @returns {Promise<FinancePlatformModel.IsCreditlinePlatformResponse>} -
270
270
  * Success response
271
271
  * @name isCreditlinePlatform
272
- * @summary: Check credit line platform status.
272
+ * @summary: Check credit line platform status
273
273
  * @description: Determine if the credit line platform is operational. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/isCreditlinePlatform/).
274
274
  */
275
275
  isCreditlinePlatform({ body, requestHeaders }?: FinancePlatformValidator.IsCreditlinePlatformParam, { responseHeaders }?: object): Promise<FinancePlatformModel.IsCreditlinePlatformResponse>;
@@ -279,7 +279,7 @@ declare class Finance {
279
279
  * @param {import("../PlatformAPIClient").Options} - Options
280
280
  * @returns {Promise<FinancePlatformModel.PaymentProcessResponse>} - Success response
281
281
  * @name paymentProcess
282
- * @summary: Process payments.
282
+ * @summary: Process payments
283
283
  * @description: Initiate and manage payment processes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/paymentProcess/).
284
284
  */
285
285
  paymentProcess({ body, requestHeaders }?: FinancePlatformValidator.PaymentProcessParam, { responseHeaders }?: object): Promise<FinancePlatformModel.PaymentProcessResponse>;
@@ -290,10 +290,10 @@ declare class Finance {
290
290
  * @returns {Promise<FinancePlatformModel.UnlockCreditNoteResponse>} -
291
291
  * Success response
292
292
  * @name unlockCreditNote
293
- * @summary: Unlocks credit notes.
293
+ * @summary: Unlock credit notes
294
294
  * @description: Used to unlock all request credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/unlockCreditNote/).
295
295
  */
296
296
  unlockCreditNote({ body, requestHeaders }?: FinancePlatformValidator.UnlockCreditNoteParam, { responseHeaders }?: object): Promise<FinancePlatformModel.UnlockCreditNoteResponse>;
297
297
  }
298
- import FinancePlatformValidator = require("./FinancePlatformValidator");
299
- import FinancePlatformModel = require("./FinancePlatformModel");
298
+ import FinancePlatformValidator = require("sdk/output/javascript/code/sdk/platform/Finance/FinancePlatformValidator");
299
+ import FinancePlatformModel = require("sdk/output/javascript/code/sdk/platform/Finance/FinancePlatformModel");
@@ -21,7 +21,7 @@ class Finance {
21
21
  * @returns {Promise<FinancePlatformModel.ChannelDisplayNameResponse>} -
22
22
  * Success response
23
23
  * @name channelDisplayName
24
- * @summary: Get channel display name.
24
+ * @summary: Get channel display name
25
25
  * @description: Retrieve the display name for a channel. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/channelDisplayName/).
26
26
  */
27
27
  async channelDisplayName(
@@ -105,7 +105,7 @@ class Finance {
105
105
  * - Success response
106
106
  *
107
107
  * @name createSellerCreditNoteConfig
108
- * @summary: Create seller credit note config.
108
+ * @summary: Create seller credit note config
109
109
  * @description: Set up configuration for seller credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/createSellerCreditNoteConfig/).
110
110
  */
111
111
  async createSellerCreditNoteConfig(
@@ -187,7 +187,7 @@ class Finance {
187
187
  * @returns {Promise<FinancePlatformModel.CreditNoteDetailsResponse>} -
188
188
  * Success response
189
189
  * @name creditNoteDetails
190
- * @summary: Get credit note details.
190
+ * @summary: Get credit note details
191
191
  * @description: Retrieve detailed information about a credit note. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/creditNoteDetails/).
192
192
  */
193
193
  async creditNoteDetails(
@@ -268,7 +268,7 @@ class Finance {
268
268
  * - Success response
269
269
  *
270
270
  * @name creditlineDataplatform
271
- * @summary: Access credit line data platform.
271
+ * @summary: Access credit line data platform
272
272
  * @description: Connect to the credit line data platform. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/creditlineDataplatform/).
273
273
  */
274
274
  async creditlineDataplatform(
@@ -349,7 +349,7 @@ class Finance {
349
349
  * @param {import("../PlatformAPIClient").Options} - Options
350
350
  * @returns {Promise<FinancePlatformModel.DeleteConfigResponse>} - Success response
351
351
  * @name deleteConfig
352
- * @summary: Deletes credit note config.
352
+ * @summary: Deletes credit note config
353
353
  * @description: Deletes credit note config. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/deleteConfig/).
354
354
  */
355
355
  async deleteConfig(
@@ -430,7 +430,7 @@ class Finance {
430
430
  * - Success response
431
431
  *
432
432
  * @name downloadCreditDebitNote
433
- * @summary: Download credit/debit note.
433
+ * @summary: Download credit/debit note
434
434
  * @description: Retrieve and save credit/debit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/downloadCreditDebitNote/).
435
435
  */
436
436
  async downloadCreditDebitNote(
@@ -511,7 +511,7 @@ class Finance {
511
511
  * @param {import("../PlatformAPIClient").Options} - Options
512
512
  * @returns {Promise<FinancePlatformModel.DownloadReportList>} - Success response
513
513
  * @name downloadReport
514
- * @summary: Download financial report.
514
+ * @summary: Download financial report
515
515
  * @description: Retrieve and save a financial report. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/downloadReport/).
516
516
  */
517
517
  async downloadReport(
@@ -592,7 +592,7 @@ class Finance {
592
592
  * - Success response
593
593
  *
594
594
  * @name downloadReportCustomerCn
595
- * @summary: Download customer credit note report.
595
+ * @summary: Download customer credit note report
596
596
  * @description: Retrieve and save a report for customer credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/downloadReportCustomerCn/).
597
597
  */
598
598
  async downloadReportCustomerCn(
@@ -673,7 +673,7 @@ class Finance {
673
673
  * @param {import("../PlatformAPIClient").Options} - Options
674
674
  * @returns {Promise<FinancePlatformModel.GenerateReportJson>} - Success response
675
675
  * @name generateReport
676
- * @summary: Generate financial report.
676
+ * @summary: Generate financial report
677
677
  * @description: Create a financial report with relevant data. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/generateReport/).
678
678
  */
679
679
  async generateReport(
@@ -754,7 +754,7 @@ class Finance {
754
754
  * - Success response
755
755
  *
756
756
  * @name generateReportCustomerCn
757
- * @summary: Generate customer credit note report.
757
+ * @summary: Generate customer credit note report
758
758
  * @description: Create a report specifically for customer credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/generateReportCustomerCn/).
759
759
  */
760
760
  async generateReportCustomerCn(
@@ -835,7 +835,7 @@ class Finance {
835
835
  * @param {import("../PlatformAPIClient").Options} - Options
836
836
  * @returns {Promise<FinancePlatformModel.GetAffiliateResponse>} - Success response
837
837
  * @name getAffiliate
838
- * @summary: Get affiliate details.
838
+ * @summary: Get affiliate details
839
839
  * @description: Retrieve information about an affiliate. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getAffiliate/).
840
840
  */
841
841
  async getAffiliate(
@@ -914,7 +914,7 @@ class Finance {
914
914
  * @param {import("../PlatformAPIClient").Options} - Options
915
915
  * @returns {Promise<FinancePlatformModel.GetCnConfigResponse>} - Success response
916
916
  * @name getCnConfig
917
- * @summary: Get credit note configuration.
917
+ * @summary: Get credit note configuration
918
918
  * @description: Retrieve configuration settings for credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getCnConfig/).
919
919
  */
920
920
  async getCnConfig(
@@ -993,7 +993,7 @@ class Finance {
993
993
  * - Success response
994
994
  *
995
995
  * @name getCustomerCreditBalance
996
- * @summary: Get customer credit balance.
996
+ * @summary: Get customer credit balance
997
997
  * @description: Retrieve the credit balance of a customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getCustomerCreditBalance/).
998
998
  */
999
999
  async getCustomerCreditBalance(
@@ -1074,7 +1074,7 @@ class Finance {
1074
1074
  * @param {import("../PlatformAPIClient").Options} - Options
1075
1075
  * @returns {Promise<FinancePlatformModel.GetEngineResponse>} - Success response
1076
1076
  * @name getData
1077
- * @summary: Get financial data.
1077
+ * @summary: Get financial data
1078
1078
  * @description: Retrieve financial data for analysis. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getData/).
1079
1079
  */
1080
1080
  async getData(
@@ -1151,7 +1151,7 @@ class Finance {
1151
1151
  * @param {import("../PlatformAPIClient").Options} - Options
1152
1152
  * @returns {Promise<FinancePlatformModel.GetPdfUrlViewResponse>} - Success response
1153
1153
  * @name getPdfUrlView
1154
- * @summary: Get PDF URL view.
1154
+ * @summary: Get PDF URL view
1155
1155
  * @description: Retrieve a URL to view a PDF document. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getPdfUrlView/).
1156
1156
  */
1157
1157
  async getPdfUrlView(
@@ -1230,7 +1230,7 @@ class Finance {
1230
1230
  * @param {import("../PlatformAPIClient").Options} - Options
1231
1231
  * @returns {Promise<FinancePlatformModel.GetReasonResponse>} - Success response
1232
1232
  * @name getReason
1233
- * @summary: Get transaction reason.
1233
+ * @summary: Get transaction reason
1234
1234
  * @description: Retrieve the reason behind a transaction. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getReason/).
1235
1235
  */
1236
1236
  async getReason(
@@ -1307,7 +1307,7 @@ class Finance {
1307
1307
  * @param {import("../PlatformAPIClient").Options} - Options
1308
1308
  * @returns {Promise<FinancePlatformModel.GetReportListResponse>} - Success response
1309
1309
  * @name getReportList
1310
- * @summary: Get report list.
1310
+ * @summary: Get report list
1311
1311
  * @description: Retrieve a list of available financial reports. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getReportList/).
1312
1312
  */
1313
1313
  async getReportList(
@@ -1387,7 +1387,7 @@ class Finance {
1387
1387
  * @returns {Promise<FinancePlatformModel.GetReportingFiltersResponse>} -
1388
1388
  * Success response
1389
1389
  * @name getReportingFilters
1390
- * @summary: Get reporting filters.
1390
+ * @summary: Get reporting filters
1391
1391
  * @description: Retrieve available filters for financial reporting. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/getReportingFilters/).
1392
1392
  */
1393
1393
  async getReportingFilters(
@@ -1471,7 +1471,7 @@ class Finance {
1471
1471
  * @returns {Promise<FinancePlatformModel.InvoiceActivityLogsResponse>} -
1472
1472
  * Success response
1473
1473
  * @name invoiceActivityLogs
1474
- * @summary: Display activity log details of an invoice.
1474
+ * @summary: Display activity log details of an invoice
1475
1475
  * @description: Display activity log details of invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceActivityLogs/).
1476
1476
  */
1477
1477
  async invoiceActivityLogs(
@@ -1550,8 +1550,8 @@ class Finance {
1550
1550
  * @param {import("../PlatformAPIClient").Options} - Options
1551
1551
  * @returns {Promise<FinancePlatformModel.InvoiceListingResponse>} - Success response
1552
1552
  * @name invoiceListing
1553
- * @summary: Gives list of invoices.
1554
- * @description: Gives list of invoices. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceListing/).
1553
+ * @summary: List invoices
1554
+ * @description: Provides list of invoices generated for a company. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceListing/).
1555
1555
  */
1556
1556
  async invoiceListing(
1557
1557
  { body, requestHeaders } = { requestHeaders: {} },
@@ -1629,7 +1629,7 @@ class Finance {
1629
1629
  * @param {import("../PlatformAPIClient").Options} - Options
1630
1630
  * @returns {Promise<FinancePlatformModel.InvoicePdfResponse>} - Success response
1631
1631
  * @name invoicePDF
1632
- * @summary: Get invoice PDF.
1632
+ * @summary: Get invoice PDF
1633
1633
  * @description: Retrieve the PDF version of an invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoicePDF/).
1634
1634
  */
1635
1635
  async invoicePDF(
@@ -1707,7 +1707,7 @@ class Finance {
1707
1707
  * @returns {Promise<FinancePlatformModel.InvoicePaymentDetailsResponse>} -
1708
1708
  * Success response
1709
1709
  * @name invoicePaymentDetails
1710
- * @summary: Display payment details of an invoice.
1710
+ * @summary: Display payment details of an invoice
1711
1711
  * @description: Display payment details of invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoicePaymentDetails/).
1712
1712
  */
1713
1713
  async invoicePaymentDetails(
@@ -1786,7 +1786,7 @@ class Finance {
1786
1786
  * @param {import("../PlatformAPIClient").Options} - Options
1787
1787
  * @returns {Promise<FinancePlatformModel.InvoiceTypeResponse>} - Success response
1788
1788
  * @name invoiceType
1789
- * @summary: Get invoice types.
1789
+ * @summary: Get invoice types
1790
1790
  * @description: Retrieve a list of available invoice types. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/invoiceType/).
1791
1791
  */
1792
1792
  async invoiceType(
@@ -1864,7 +1864,7 @@ class Finance {
1864
1864
  * @returns {Promise<FinancePlatformModel.IsCnRefundMethodResponse>} -
1865
1865
  * Success response
1866
1866
  * @name isCnRefundMethod
1867
- * @summary: Check CN refund method.
1867
+ * @summary: Check refund method
1868
1868
  * @description: Verify the refund method for credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/isCnRefundMethod/).
1869
1869
  */
1870
1870
  async isCnRefundMethod(
@@ -1944,7 +1944,7 @@ class Finance {
1944
1944
  * @returns {Promise<FinancePlatformModel.IsCreditlinePlatformResponse>} -
1945
1945
  * Success response
1946
1946
  * @name isCreditlinePlatform
1947
- * @summary: Check credit line platform status.
1947
+ * @summary: Check credit line platform status
1948
1948
  * @description: Determine if the credit line platform is operational. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/isCreditlinePlatform/).
1949
1949
  */
1950
1950
  async isCreditlinePlatform(
@@ -2023,7 +2023,7 @@ class Finance {
2023
2023
  * @param {import("../PlatformAPIClient").Options} - Options
2024
2024
  * @returns {Promise<FinancePlatformModel.PaymentProcessResponse>} - Success response
2025
2025
  * @name paymentProcess
2026
- * @summary: Process payments.
2026
+ * @summary: Process payments
2027
2027
  * @description: Initiate and manage payment processes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/paymentProcess/).
2028
2028
  */
2029
2029
  async paymentProcess(
@@ -2103,7 +2103,7 @@ class Finance {
2103
2103
  * @returns {Promise<FinancePlatformModel.UnlockCreditNoteResponse>} -
2104
2104
  * Success response
2105
2105
  * @name unlockCreditNote
2106
- * @summary: Unlocks credit notes.
2106
+ * @summary: Unlock credit notes
2107
2107
  * @description: Used to unlock all request credit notes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/finance/unlockCreditNote/).
2108
2108
  */
2109
2109
  async unlockCreditNote(
@@ -268,4 +268,4 @@ type PaymentProcessParam = {
268
268
  type UnlockCreditNoteParam = {
269
269
  body: FinancePlatformModel.UnlockCreditNoteRequest;
270
270
  };
271
- import FinancePlatformModel = require("./FinancePlatformModel");
271
+ import FinancePlatformModel = require("sdk/output/javascript/code/sdk/platform/Finance/FinancePlatformModel");
@@ -9,7 +9,7 @@ declare class Lead {
9
9
  * @param {import("../PlatformAPIClient").Options} - Options
10
10
  * @returns {Promise<LeadPlatformModel.CloseVideoRoomResponse>} - Success response
11
11
  * @name closeVideoRoom
12
- * @summary: Close video room.
12
+ * @summary: Close video room
13
13
  * @description: Terminate and close an active video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/closeVideoRoom/).
14
14
  */
15
15
  closeVideoRoom({ uniqueName, requestHeaders }?: LeadPlatformApplicationValidator.CloseVideoRoomParam, { responseHeaders }?: object): Promise<LeadPlatformModel.CloseVideoRoomResponse>;
@@ -19,7 +19,7 @@ declare class Lead {
19
19
  * @param {import("../PlatformAPIClient").Options} - Options
20
20
  * @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
21
21
  * @name createCustomForm
22
- * @summary: Create custom form.
22
+ * @summary: Create custom form
23
23
  * @description: Create a new custom form for application users to fill - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/createCustomForm/).
24
24
  */
25
25
  createCustomForm({ body, requestHeaders }?: LeadPlatformApplicationValidator.CreateCustomFormParam, { responseHeaders }?: object): Promise<LeadPlatformModel.CustomForm>;
@@ -29,7 +29,7 @@ declare class Lead {
29
29
  * @param {import("../PlatformAPIClient").Options} - Options
30
30
  * @returns {Promise<LeadPlatformModel.TicketHistory>} - Success response
31
31
  * @name createNewHistory
32
- * @summary: Create history for specific application level ticket
32
+ * @summary: Create ticket history interaction
33
33
  * @description: Create history for specific application level ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/createNewHistory/).
34
34
  */
35
35
  createNewHistory({ id, body, requestHeaders }?: LeadPlatformApplicationValidator.CreateNewHistoryParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketHistory>;
@@ -49,8 +49,8 @@ declare class Lead {
49
49
  * @param {import("../PlatformAPIClient").Options} - Options
50
50
  * @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
51
51
  * @name editCustomForm
52
- * @summary: Edit custom form.
53
- * @description: Modify the content and assosciated settings of a custom form. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/editCustomForm/).
52
+ * @summary: Update custom form
53
+ * @description: Modify the content and associated settings of a custom form. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/editCustomForm/).
54
54
  */
55
55
  editCustomForm({ slug, body, requestHeaders }?: LeadPlatformApplicationValidator.EditCustomFormParam, { responseHeaders }?: object): Promise<LeadPlatformModel.CustomForm>;
56
56
  /**
@@ -59,7 +59,7 @@ declare class Lead {
59
59
  * @param {import("../PlatformAPIClient").Options} - Options
60
60
  * @returns {Promise<LeadPlatformModel.Ticket>} - Success response
61
61
  * @name editNewTicket
62
- * @summary: Edits ticket details of a application level ticket
62
+ * @summary: Update Ticket Details
63
63
  * @description: Edits ticket details of a application level ticket such as status, priority, category, tags, attachments, assigne & ticket content changes - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/editNewTicket/).
64
64
  */
65
65
  editNewTicket({ id, body, requestHeaders }?: LeadPlatformApplicationValidator.EditNewTicketParam, { responseHeaders }?: object): Promise<LeadPlatformModel.Ticket>;
@@ -69,8 +69,8 @@ declare class Lead {
69
69
  * @param {import("../PlatformAPIClient").Options} - Options
70
70
  * @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
71
71
  * @name getCustomForm
72
- * @summary: Get custom form.
73
- * @description: Retrieve information about a custom form which includes corresponding field details and any validation regex required against that field or not - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getCustomForm/).
72
+ * @summary: Get custom form
73
+ * @description: Get information about a custom form which includes corresponding field details and any validation regex required against that field or not - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getCustomForm/).
74
74
  */
75
75
  getCustomForm({ slug, requestHeaders }?: LeadPlatformApplicationValidator.GetCustomFormParam, { responseHeaders }?: object): Promise<LeadPlatformModel.CustomForm>;
76
76
  /**
@@ -79,8 +79,8 @@ declare class Lead {
79
79
  * @param {import("../PlatformAPIClient").Options} - Options
80
80
  * @returns {Promise<LeadPlatformModel.CustomFormList>} - Success response
81
81
  * @name getCustomForms
82
- * @summary: Get custom forms.
83
- * @description: Retrieve a list of available custom forms. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getCustomForms/).
82
+ * @summary: Get custom forms
83
+ * @description: List all available custom forms - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getCustomForms/).
84
84
  */
85
85
  getCustomForms({ requestHeaders }?: any, { responseHeaders }?: object): Promise<LeadPlatformModel.CustomFormList>;
86
86
  /**
@@ -89,8 +89,8 @@ declare class Lead {
89
89
  * @param {import("../PlatformAPIClient").Options} - Options
90
90
  * @returns {Promise<LeadPlatformModel.Ticket>} - Success response
91
91
  * @name getNewTicket
92
- * @summary: Retreives ticket details of a application level ticket
93
- * @description: Retreives ticket details of a application level ticket with ticket ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getNewTicket/).
92
+ * @summary: Get Ticket Details
93
+ * @description: Get ticket details of a application level ticket with ticket ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getNewTicket/).
94
94
  */
95
95
  getNewTicket({ id, requestHeaders }?: LeadPlatformApplicationValidator.GetNewTicketParam, { responseHeaders }?: object): Promise<LeadPlatformModel.Ticket>;
96
96
  /**
@@ -99,7 +99,7 @@ declare class Lead {
99
99
  * @param {import("../PlatformAPIClient").Options} - Options
100
100
  * @returns {Promise<LeadPlatformModel.TicketHistoryList>} - Success response
101
101
  * @name getNewTicketHistory
102
- * @summary: Gets history list for specific application level ticket
102
+ * @summary: Get ticket history interaction
103
103
  * @description: Gets history list for specific application level ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getNewTicketHistory/).
104
104
  */
105
105
  getNewTicketHistory({ id, requestHeaders }?: LeadPlatformApplicationValidator.GetNewTicketHistoryParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketHistoryList>;
@@ -109,7 +109,7 @@ declare class Lead {
109
109
  * @param {import("../PlatformAPIClient").Options} - Options
110
110
  * @returns {Promise<LeadPlatformModel.TicketList>} - Success response
111
111
  * @name getNewTickets
112
- * @summary: Gets the list of Application level Tickets and/or ticket filters depending on query params
112
+ * @summary: List sales channel tickets
113
113
  * @description: Gets the list of Application level Tickets and/or ticket filters - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getNewTickets/).
114
114
  */
115
115
  getNewTickets({ items, filters, q, status, priority, category, requestHeaders }?: LeadPlatformApplicationValidator.GetNewTicketsParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketList>;
@@ -122,7 +122,7 @@ declare class Lead {
122
122
  * @returns {Promise<LeadPlatformModel.GetTokenForVideoRoomResponse>} -
123
123
  * Success response
124
124
  * @name getNewTokenForVideoRoom
125
- * @summary: Get Token to join a specific Video Room using it's unqiue name
125
+ * @summary: Get video Room Token
126
126
  * @description: Get Token to join a specific Video Room using it's unqiue name, this Token is your ticket to Room and also creates your identity there. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getNewTokenForVideoRoom/).
127
127
  */
128
128
  getNewTokenForVideoRoom({ uniqueName, requestHeaders }?: LeadPlatformApplicationValidator.GetNewTokenForVideoRoomParam, { responseHeaders }?: object): Promise<LeadPlatformModel.GetTokenForVideoRoomResponse>;
@@ -136,7 +136,7 @@ declare class Lead {
136
136
  * - Success response
137
137
  *
138
138
  * @name getNewVideoParticipants
139
- * @summary: Get participants of a specific Video Room using it's unique name
139
+ * @summary: List video Room Participants
140
140
  * @description: Get participants of a specific Video Room using it's unique name, this can be used to check if people are already there in the room and also to show their names. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getNewVideoParticipants/).
141
141
  */
142
142
  getNewVideoParticipants({ uniqueName, requestHeaders }?: LeadPlatformApplicationValidator.GetNewVideoParticipantsParam, { responseHeaders }?: object): Promise<LeadPlatformModel.GetParticipantsInsideVideoRoomResponse>;
@@ -146,10 +146,10 @@ declare class Lead {
146
146
  * @param {import("../PlatformAPIClient").Options} - Options
147
147
  * @returns {Promise<LeadPlatformModel.CreateVideoRoomResponse>} - Success response
148
148
  * @name openVideoRoom
149
- * @summary: Open video room.
149
+ * @summary: Open video room
150
150
  * @description: Initiate and open a video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/openVideoRoom/).
151
151
  */
152
152
  openVideoRoom({ body, requestHeaders }?: LeadPlatformApplicationValidator.OpenVideoRoomParam, { responseHeaders }?: object): Promise<LeadPlatformModel.CreateVideoRoomResponse>;
153
153
  }
154
- import LeadPlatformApplicationValidator = require("./LeadPlatformApplicationValidator");
155
- import LeadPlatformModel = require("./LeadPlatformModel");
154
+ import LeadPlatformApplicationValidator = require("sdk/output/javascript/code/sdk/platform/Lead/LeadPlatformApplicationValidator");
155
+ import LeadPlatformModel = require("sdk/output/javascript/code/sdk/platform/Lead/LeadPlatformModel");