@gofynd/fdk-client-javascript 1.4.3 → 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 (193) 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 +1 -1
  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/ApplicationClient.d.ts +17 -17
  11. package/sdk/application/ApplicationConfig.d.ts +3 -3
  12. package/sdk/application/Cart/CartApplicationClient.d.ts +50 -50
  13. package/sdk/application/Cart/CartApplicationClient.js +48 -48
  14. package/sdk/application/Cart/CartApplicationValidator.d.ts +1 -1
  15. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +72 -72
  16. package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
  17. package/sdk/application/Common/CommonApplicationClient.d.ts +6 -6
  18. package/sdk/application/Common/CommonApplicationClient.js +4 -4
  19. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +8 -8
  20. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
  21. package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
  22. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +34 -34
  23. package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
  24. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +1 -1
  25. package/sdk/application/Content/ContentApplicationClient.d.ts +48 -48
  26. package/sdk/application/Content/ContentApplicationClient.js +45 -45
  27. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +7 -7
  28. package/sdk/application/FileStorage/FileStorageApplicationClient.js +5 -5
  29. package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
  30. package/sdk/application/Lead/LeadApplicationClient.d.ts +11 -11
  31. package/sdk/application/Lead/LeadApplicationClient.js +9 -9
  32. package/sdk/application/Lead/LeadApplicationValidator.d.ts +1 -1
  33. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +24 -24
  34. package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
  35. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +1 -1
  36. package/sdk/application/Order/OrderApplicationClient.d.ts +16 -27
  37. package/sdk/application/Order/OrderApplicationClient.js +14 -94
  38. package/sdk/application/Order/OrderApplicationValidator.d.ts +2 -16
  39. package/sdk/application/Order/OrderApplicationValidator.js +0 -13
  40. package/sdk/application/Payment/PaymentApplicationClient.d.ts +73 -73
  41. package/sdk/application/Payment/PaymentApplicationClient.js +71 -71
  42. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +1 -1
  43. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +2 -2
  44. package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +1 -1
  45. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +3 -3
  46. package/sdk/application/Rewards/RewardsApplicationClient.js +1 -1
  47. package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +1 -1
  48. package/sdk/application/Share/ShareApplicationClient.d.ts +3 -3
  49. package/sdk/application/Share/ShareApplicationClient.js +1 -1
  50. package/sdk/application/Share/ShareApplicationValidator.d.ts +1 -1
  51. package/sdk/application/Theme/ThemeApplicationClient.d.ts +10 -10
  52. package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
  53. package/sdk/application/User/UserApplicationClient.d.ts +76 -76
  54. package/sdk/application/User/UserApplicationClient.js +74 -74
  55. package/sdk/application/User/UserApplicationValidator.d.ts +1 -1
  56. package/sdk/application/index.d.ts +18 -18
  57. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +1 -1
  58. package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
  59. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +1 -1
  60. package/sdk/partner/OAuthClient.d.ts +4 -4
  61. package/sdk/partner/PartnerAPIClient.d.ts +1 -1
  62. package/sdk/partner/PartnerClient.d.ts +6 -6
  63. package/sdk/partner/PartnerConfig.d.ts +4 -4
  64. package/sdk/partner/Theme/ThemePartnerClient.d.ts +1 -1
  65. package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +1 -1
  66. package/sdk/partner/index.d.ts +7 -7
  67. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +7 -7
  68. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +5 -5
  69. package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
  70. package/sdk/platform/Billing/BillingPlatformClient.d.ts +15 -15
  71. package/sdk/platform/Billing/BillingPlatformClient.js +13 -13
  72. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +1 -1
  73. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +104 -104
  74. package/sdk/platform/Cart/CartPlatformApplicationClient.js +102 -102
  75. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +1 -1
  76. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +135 -134
  77. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +132 -131
  78. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1 -1
  79. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +133 -133
  80. package/sdk/platform/Catalog/CatalogPlatformClient.js +130 -130
  81. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1 -1
  82. package/sdk/platform/Common/CommonPlatformClient.d.ts +4 -4
  83. package/sdk/platform/Common/CommonPlatformClient.js +2 -2
  84. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +120 -120
  85. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +118 -118
  86. package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +1 -1
  87. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +3 -3
  88. package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
  89. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +25 -25
  90. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +22 -22
  91. package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +1 -1
  92. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +43 -43
  93. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +41 -41
  94. package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +1 -1
  95. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +28 -28
  96. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +26 -26
  97. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +1 -1
  98. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +96 -96
  99. package/sdk/platform/Content/ContentPlatformApplicationClient.js +93 -93
  100. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -1
  101. package/sdk/platform/Content/ContentPlatformClient.d.ts +31 -31
  102. package/sdk/platform/Content/ContentPlatformClient.js +29 -29
  103. package/sdk/platform/Content/ContentPlatformValidator.d.ts +1 -1
  104. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +20 -20
  105. package/sdk/platform/Discount/DiscountPlatformClient.js +18 -18
  106. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +1 -1
  107. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +20 -19
  108. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +18 -17
  109. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
  110. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
  111. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
  112. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +2 -2
  113. package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +1 -1
  114. package/sdk/platform/Finance/FinancePlatformClient.d.ts +6 -6
  115. package/sdk/platform/Finance/FinancePlatformClient.js +4 -4
  116. package/sdk/platform/Finance/FinancePlatformValidator.d.ts +1 -1
  117. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +14 -14
  118. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
  119. package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +1 -1
  120. package/sdk/platform/Lead/LeadPlatformClient.d.ts +17 -17
  121. package/sdk/platform/Lead/LeadPlatformClient.js +15 -15
  122. package/sdk/platform/Lead/LeadPlatformValidator.d.ts +1 -1
  123. package/sdk/platform/OAuthClient.d.ts +3 -3
  124. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +12 -12
  125. package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
  126. package/sdk/platform/Order/OrderPlatformClient.d.ts +97 -108
  127. package/sdk/platform/Order/OrderPlatformClient.js +95 -190
  128. package/sdk/platform/Order/OrderPlatformModel.d.ts +10 -0
  129. package/sdk/platform/Order/OrderPlatformModel.js +4 -0
  130. package/sdk/platform/Order/OrderPlatformValidator.d.ts +2 -34
  131. package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
  132. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -6
  133. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
  134. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -1
  135. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +79 -79
  136. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +77 -77
  137. package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +1 -1
  138. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +4 -4
  139. package/sdk/platform/Payment/PaymentPlatformClient.js +2 -2
  140. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
  141. package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
  142. package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +1 -1
  143. package/sdk/platform/PlatformAPIClient.d.ts +1 -1
  144. package/sdk/platform/PlatformApplicationClient.d.ts +16 -16
  145. package/sdk/platform/PlatformClient.d.ts +19 -21
  146. package/sdk/platform/PlatformClient.js +0 -4
  147. package/sdk/platform/PlatformConfig.d.ts +4 -4
  148. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +9 -9
  149. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +7 -7
  150. package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +1 -1
  151. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +42 -42
  152. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
  153. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +1 -1
  154. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +53 -52
  155. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +51 -50
  156. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +1 -1
  157. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +3 -3
  158. package/sdk/platform/Share/SharePlatformApplicationClient.js +1 -1
  159. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +1 -1
  160. package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
  161. package/sdk/platform/Share/SharePlatformModel.js +2 -0
  162. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +36 -106
  163. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +34 -591
  164. package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +2 -101
  165. package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
  166. package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -8
  167. package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
  168. package/sdk/platform/Theme/ThemePlatformValidator.d.ts +1 -1
  169. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +37 -37
  170. package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
  171. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +1 -1
  172. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -8
  173. package/sdk/platform/Webhook/WebhookPlatformClient.js +7 -6
  174. package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +1 -1
  175. package/sdk/platform/index.d.ts +24 -25
  176. package/sdk/platform/index.js +0 -2
  177. package/sdk/public/Billing/BillingPublicClient.d.ts +2 -2
  178. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
  179. package/sdk/public/Content/ContentPublicClient.d.ts +2 -2
  180. package/sdk/public/Inventory/InventoryPublicClient.d.ts +2 -2
  181. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +1 -1
  182. package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
  183. package/sdk/public/PublicAPIClient.d.ts +1 -1
  184. package/sdk/public/PublicClient.d.ts +7 -7
  185. package/sdk/public/Webhook/WebhookPublicClient.d.ts +2 -2
  186. package/sdk/public/Webhook/WebhookPublicValidator.d.ts +1 -1
  187. package/sdk/public/index.d.ts +8 -8
  188. package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +0 -152
  189. package/sdk/platform/Inventory/InventoryPlatformClient.js +0 -1017
  190. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +0 -1355
  191. package/sdk/platform/Inventory/InventoryPlatformModel.js +0 -1544
  192. package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +0 -171
  193. package/sdk/platform/Inventory/InventoryPlatformValidator.js +0 -159
@@ -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>;
@@ -70,7 +70,7 @@ declare class Lead {
70
70
  * @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
71
71
  * @name getCustomForm
72
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/).
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
  /**
@@ -80,7 +80,7 @@ declare class Lead {
80
80
  * @returns {Promise<LeadPlatformModel.CustomFormList>} - Success response
81
81
  * @name getCustomForms
82
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/).
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>;
@@ -151,5 +151,5 @@ declare class Lead {
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");
@@ -179,7 +179,7 @@ class Lead {
179
179
  * @param {import("../PlatformAPIClient").Options} - Options
180
180
  * @returns {Promise<LeadPlatformModel.TicketHistory>} - Success response
181
181
  * @name createNewHistory
182
- * @summary: Create history for specific application level ticket
182
+ * @summary: Create ticket history interaction
183
183
  * @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/).
184
184
  */
185
185
  async createNewHistory(
@@ -339,8 +339,8 @@ class Lead {
339
339
  * @param {import("../PlatformAPIClient").Options} - Options
340
340
  * @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
341
341
  * @name editCustomForm
342
- * @summary: Edit custom form
343
- * @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/).
342
+ * @summary: Update custom form
343
+ * @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/).
344
344
  */
345
345
  async editCustomForm(
346
346
  { slug, body, requestHeaders } = { requestHeaders: {} },
@@ -420,7 +420,7 @@ class Lead {
420
420
  * @param {import("../PlatformAPIClient").Options} - Options
421
421
  * @returns {Promise<LeadPlatformModel.Ticket>} - Success response
422
422
  * @name editNewTicket
423
- * @summary: Edits ticket details of a application level ticket
423
+ * @summary: Update Ticket Details
424
424
  * @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/).
425
425
  */
426
426
  async editNewTicket(
@@ -500,7 +500,7 @@ class Lead {
500
500
  * @returns {Promise<LeadPlatformModel.CustomForm>} - Success response
501
501
  * @name getCustomForm
502
502
  * @summary: Get custom form
503
- * @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/).
503
+ * @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/).
504
504
  */
505
505
  async getCustomForm(
506
506
  { slug, requestHeaders } = { requestHeaders: {} },
@@ -577,7 +577,7 @@ class Lead {
577
577
  * @returns {Promise<LeadPlatformModel.CustomFormList>} - Success response
578
578
  * @name getCustomForms
579
579
  * @summary: Get custom forms
580
- * @description: Retrieve a list of available custom forms. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getCustomForms/).
580
+ * @description: List all available custom forms - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getCustomForms/).
581
581
  */
582
582
  async getCustomForms(
583
583
  { requestHeaders } = { requestHeaders: {} },
@@ -651,8 +651,8 @@ class Lead {
651
651
  * @param {import("../PlatformAPIClient").Options} - Options
652
652
  * @returns {Promise<LeadPlatformModel.Ticket>} - Success response
653
653
  * @name getNewTicket
654
- * @summary: Retreives ticket details of a application level ticket
655
- * @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/).
654
+ * @summary: Get Ticket Details
655
+ * @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/).
656
656
  */
657
657
  async getNewTicket(
658
658
  { id, requestHeaders } = { requestHeaders: {} },
@@ -728,7 +728,7 @@ class Lead {
728
728
  * @param {import("../PlatformAPIClient").Options} - Options
729
729
  * @returns {Promise<LeadPlatformModel.TicketHistoryList>} - Success response
730
730
  * @name getNewTicketHistory
731
- * @summary: Gets history list for specific application level ticket
731
+ * @summary: Get ticket history interaction
732
732
  * @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/).
733
733
  */
734
734
  async getNewTicketHistory(
@@ -807,7 +807,7 @@ class Lead {
807
807
  * @param {import("../PlatformAPIClient").Options} - Options
808
808
  * @returns {Promise<LeadPlatformModel.TicketList>} - Success response
809
809
  * @name getNewTickets
810
- * @summary: Gets the list of Application level Tickets and/or ticket filters depending on query params
810
+ * @summary: List sales channel tickets
811
811
  * @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/).
812
812
  */
813
813
  async getNewTickets(
@@ -905,7 +905,7 @@ class Lead {
905
905
  * @returns {Promise<LeadPlatformModel.GetTokenForVideoRoomResponse>} -
906
906
  * Success response
907
907
  * @name getNewTokenForVideoRoom
908
- * @summary: Get Token to join a specific Video Room using it's unqiue name
908
+ * @summary: Get video Room Token
909
909
  * @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/).
910
910
  */
911
911
  async getNewTokenForVideoRoom(
@@ -988,7 +988,7 @@ class Lead {
988
988
  * - Success response
989
989
  *
990
990
  * @name getNewVideoParticipants
991
- * @summary: Get participants of a specific Video Room using it's unique name
991
+ * @summary: List video Room Participants
992
992
  * @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/).
993
993
  */
994
994
  async getNewVideoParticipants(
@@ -191,4 +191,4 @@ type OpenVideoRoomParam = {
191
191
  body: LeadPlatformModel.CreateVideoRoomPayload;
192
192
  };
193
193
  type GetCustomFormsParam = any;
194
- import LeadPlatformModel = require("./LeadPlatformModel");
194
+ import LeadPlatformModel = require("sdk/output/javascript/code/sdk/platform/Lead/LeadPlatformModel");
@@ -8,7 +8,7 @@ declare class Lead {
8
8
  * @param {import("../PlatformAPIClient").Options} - Options
9
9
  * @returns {Promise<LeadPlatformModel.TicketHistory>} - Success response
10
10
  * @name createPlatformTicketHistory
11
- * @summary: Create platform ticket history
11
+ * @summary: Create ticket history
12
12
  * @description: Create futher interactions on a company level ticket such as changing it's status, priority or replying to a ticket via a thread. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/createPlatformTicketHistory/).
13
13
  */
14
14
  createPlatformTicketHistory({ id, body, requestHeaders }?: LeadPlatformValidator.CreatePlatformTicketHistoryParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketHistory>;
@@ -28,7 +28,7 @@ declare class Lead {
28
28
  * @param {import("../PlatformAPIClient").Options} - Options
29
29
  * @returns {Promise<LeadPlatformModel.Ticket>} - Success response
30
30
  * @name editPlatformTicket
31
- * @summary: Edit platform ticket
31
+ * @summary: Update a ticket
32
32
  * @description: Modify the content and settings of a specific company level ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/editPlatformTicket/).
33
33
  */
34
34
  editPlatformTicket({ id, body, requestHeaders }?: LeadPlatformValidator.EditPlatformTicketParam, { responseHeaders }?: object): Promise<LeadPlatformModel.Ticket>;
@@ -38,8 +38,8 @@ declare class Lead {
38
38
  * @param {import("../PlatformAPIClient").Options} - Options
39
39
  * @returns {Promise<LeadPlatformModel.TicketFeedbackList>} - Success response
40
40
  * @name getFeedbacks
41
- * @summary: Get feedbacks
42
- * @description: Retrieve feedback information related to a ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getFeedbacks/).
41
+ * @summary: List feedbacks
42
+ * @description: Get feedback information related to a ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getFeedbacks/).
43
43
  */
44
44
  getFeedbacks({ id, requestHeaders }?: LeadPlatformValidator.GetFeedbacksParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketFeedbackList>;
45
45
  /**
@@ -49,7 +49,7 @@ declare class Lead {
49
49
  * @returns {Promise<LeadPlatformModel.CloseVideoRoomResponse>} - Success response
50
50
  * @name getGeneralConfig
51
51
  * @summary: Get general configuration
52
- * @description: Retrieve general configuration settings related to support system for company tickets - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getGeneralConfig/).
52
+ * @description: Get general configuration settings related to support system for company tickets - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getGeneralConfig/).
53
53
  */
54
54
  getGeneralConfig({ requestHeaders }?: any, { responseHeaders }?: object): Promise<LeadPlatformModel.CloseVideoRoomResponse>;
55
55
  /**
@@ -58,8 +58,8 @@ declare class Lead {
58
58
  * @param {import("../PlatformAPIClient").Options} - Options
59
59
  * @returns {Promise<LeadPlatformModel.Ticket>} - Success response
60
60
  * @name getPlatformTicket
61
- * @summary: Get platform ticket
62
- * @description: Retrieve detailed information about a specific ticket which is raised at company level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformTicket/).
61
+ * @summary: Get a ticket
62
+ * @description: Get detailed information about a specific ticket which is raised at company level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformTicket/).
63
63
  */
64
64
  getPlatformTicket({ id, requestHeaders }?: LeadPlatformValidator.GetPlatformTicketParam, { responseHeaders }?: object): Promise<LeadPlatformModel.Ticket>;
65
65
  /**
@@ -68,8 +68,8 @@ declare class Lead {
68
68
  * @param {import("../PlatformAPIClient").Options} - Options
69
69
  * @returns {Promise<LeadPlatformModel.TicketHistoryList>} - Success response
70
70
  * @name getPlatformTicketHistory
71
- * @summary: Get platform ticket history
72
- * @description: Retrieve a list of history records for a company level ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformTicketHistory/).
71
+ * @summary: Get ticket history
72
+ * @description: List history records for a company level ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformTicketHistory/).
73
73
  */
74
74
  getPlatformTicketHistory({ id, requestHeaders }?: LeadPlatformValidator.GetPlatformTicketHistoryParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketHistoryList>;
75
75
  /**
@@ -78,8 +78,8 @@ declare class Lead {
78
78
  * @param {import("../PlatformAPIClient").Options} - Options
79
79
  * @returns {Promise<LeadPlatformModel.TicketList>} - Success response
80
80
  * @name getPlatformTickets
81
- * @summary: Get platform tickets
82
- * @description: Retrieve a list of tickets created within the platform at company level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformTickets/).
81
+ * @summary: List tickets
82
+ * @description: List all tickets created within the platform at company level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformTickets/).
83
83
  */
84
84
  getPlatformTickets({ items, filters, q, status, priority, category, pageNo, pageSize, requestHeaders, }?: LeadPlatformValidator.GetPlatformTicketsParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketList>;
85
85
  /**
@@ -90,8 +90,8 @@ declare class Lead {
90
90
  * - Success response
91
91
  *
92
92
  * @name getPlatformVideoParticipants
93
- * @summary: Get platform video participants
94
- * @description: Retrieve a list of participants in a platform video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformVideoParticipants/).
93
+ * @summary: List video Room Participants
94
+ * @description: Get a list of participants in a platform video room - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformVideoParticipants/).
95
95
  */
96
96
  getPlatformVideoParticipants({ uniqueName, requestHeaders }?: LeadPlatformValidator.GetPlatformVideoParticipantsParam, { responseHeaders }?: object): Promise<LeadPlatformModel.GetParticipantsInsideVideoRoomResponse>;
97
97
  /**
@@ -101,8 +101,8 @@ declare class Lead {
101
101
  * @returns {Promise<LeadPlatformModel.GetTokenForVideoRoomResponse>} -
102
102
  * Success response
103
103
  * @name getTokenForPlatformVideoRoom
104
- * @summary: Get token for platform video room
105
- * @description: Retrieve an access token for a platform video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getTokenForPlatformVideoRoom/).
104
+ * @summary: Get video Room Token
105
+ * @description: Get an access token for a platform video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getTokenForPlatformVideoRoom/).
106
106
  */
107
107
  getTokenForPlatformVideoRoom({ uniqueName, requestHeaders }?: LeadPlatformValidator.GetTokenForPlatformVideoRoomParam, { responseHeaders }?: object): Promise<LeadPlatformModel.GetTokenForVideoRoomResponse>;
108
108
  /**
@@ -116,5 +116,5 @@ declare class Lead {
116
116
  */
117
117
  submitFeedback({ id, body, requestHeaders }?: LeadPlatformValidator.SubmitFeedbackParam, { responseHeaders }?: object): Promise<LeadPlatformModel.TicketFeedback>;
118
118
  }
119
- import LeadPlatformValidator = require("./LeadPlatformValidator");
120
- import LeadPlatformModel = require("./LeadPlatformModel");
119
+ import LeadPlatformValidator = require("sdk/output/javascript/code/sdk/platform/Lead/LeadPlatformValidator");
120
+ import LeadPlatformModel = require("sdk/output/javascript/code/sdk/platform/Lead/LeadPlatformModel");
@@ -20,7 +20,7 @@ class Lead {
20
20
  * @param {import("../PlatformAPIClient").Options} - Options
21
21
  * @returns {Promise<LeadPlatformModel.TicketHistory>} - Success response
22
22
  * @name createPlatformTicketHistory
23
- * @summary: Create platform ticket history
23
+ * @summary: Create ticket history
24
24
  * @description: Create futher interactions on a company level ticket such as changing it's status, priority or replying to a ticket via a thread. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/createPlatformTicketHistory/).
25
25
  */
26
26
  async createPlatformTicketHistory(
@@ -180,7 +180,7 @@ class Lead {
180
180
  * @param {import("../PlatformAPIClient").Options} - Options
181
181
  * @returns {Promise<LeadPlatformModel.Ticket>} - Success response
182
182
  * @name editPlatformTicket
183
- * @summary: Edit platform ticket
183
+ * @summary: Update a ticket
184
184
  * @description: Modify the content and settings of a specific company level ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/editPlatformTicket/).
185
185
  */
186
186
  async editPlatformTicket(
@@ -261,8 +261,8 @@ class Lead {
261
261
  * @param {import("../PlatformAPIClient").Options} - Options
262
262
  * @returns {Promise<LeadPlatformModel.TicketFeedbackList>} - Success response
263
263
  * @name getFeedbacks
264
- * @summary: Get feedbacks
265
- * @description: Retrieve feedback information related to a ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getFeedbacks/).
264
+ * @summary: List feedbacks
265
+ * @description: Get feedback information related to a ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getFeedbacks/).
266
266
  */
267
267
  async getFeedbacks(
268
268
  { id, requestHeaders } = { requestHeaders: {} },
@@ -339,7 +339,7 @@ class Lead {
339
339
  * @returns {Promise<LeadPlatformModel.CloseVideoRoomResponse>} - Success response
340
340
  * @name getGeneralConfig
341
341
  * @summary: Get general configuration
342
- * @description: Retrieve general configuration settings related to support system for company tickets - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getGeneralConfig/).
342
+ * @description: Get general configuration settings related to support system for company tickets - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getGeneralConfig/).
343
343
  */
344
344
  async getGeneralConfig(
345
345
  { requestHeaders } = { requestHeaders: {} },
@@ -413,8 +413,8 @@ class Lead {
413
413
  * @param {import("../PlatformAPIClient").Options} - Options
414
414
  * @returns {Promise<LeadPlatformModel.Ticket>} - Success response
415
415
  * @name getPlatformTicket
416
- * @summary: Get platform ticket
417
- * @description: Retrieve detailed information about a specific ticket which is raised at company level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformTicket/).
416
+ * @summary: Get a ticket
417
+ * @description: Get detailed information about a specific ticket which is raised at company level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformTicket/).
418
418
  */
419
419
  async getPlatformTicket(
420
420
  { id, requestHeaders } = { requestHeaders: {} },
@@ -492,8 +492,8 @@ class Lead {
492
492
  * @param {import("../PlatformAPIClient").Options} - Options
493
493
  * @returns {Promise<LeadPlatformModel.TicketHistoryList>} - Success response
494
494
  * @name getPlatformTicketHistory
495
- * @summary: Get platform ticket history
496
- * @description: Retrieve a list of history records for a company level ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformTicketHistory/).
495
+ * @summary: Get ticket history
496
+ * @description: List history records for a company level ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformTicketHistory/).
497
497
  */
498
498
  async getPlatformTicketHistory(
499
499
  { id, requestHeaders } = { requestHeaders: {} },
@@ -571,8 +571,8 @@ class Lead {
571
571
  * @param {import("../PlatformAPIClient").Options} - Options
572
572
  * @returns {Promise<LeadPlatformModel.TicketList>} - Success response
573
573
  * @name getPlatformTickets
574
- * @summary: Get platform tickets
575
- * @description: Retrieve a list of tickets created within the platform at company level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformTickets/).
574
+ * @summary: List tickets
575
+ * @description: List all tickets created within the platform at company level - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformTickets/).
576
576
  */
577
577
  async getPlatformTickets(
578
578
  {
@@ -684,8 +684,8 @@ class Lead {
684
684
  * - Success response
685
685
  *
686
686
  * @name getPlatformVideoParticipants
687
- * @summary: Get platform video participants
688
- * @description: Retrieve a list of participants in a platform video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformVideoParticipants/).
687
+ * @summary: List video Room Participants
688
+ * @description: Get a list of participants in a platform video room - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getPlatformVideoParticipants/).
689
689
  */
690
690
  async getPlatformVideoParticipants(
691
691
  { uniqueName, requestHeaders } = { requestHeaders: {} },
@@ -766,8 +766,8 @@ class Lead {
766
766
  * @returns {Promise<LeadPlatformModel.GetTokenForVideoRoomResponse>} -
767
767
  * Success response
768
768
  * @name getTokenForPlatformVideoRoom
769
- * @summary: Get token for platform video room
770
- * @description: Retrieve an access token for a platform video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getTokenForPlatformVideoRoom/).
769
+ * @summary: Get video Room Token
770
+ * @description: Get an access token for a platform video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/lead/getTokenForPlatformVideoRoom/).
771
771
  */
772
772
  async getTokenForPlatformVideoRoom(
773
773
  { uniqueName, requestHeaders } = { requestHeaders: {} },
@@ -172,4 +172,4 @@ type SubmitFeedbackParam = {
172
172
  body: LeadPlatformModel.TicketFeedbackPayload;
173
173
  };
174
174
  type GetGeneralConfigParam = any;
175
- import LeadPlatformModel = require("./LeadPlatformModel");
175
+ import LeadPlatformModel = require("sdk/output/javascript/code/sdk/platform/Lead/LeadPlatformModel");
@@ -20,7 +20,7 @@ declare class OAuthClient {
20
20
  grant_type: any;
21
21
  refresh_token: any;
22
22
  code: any;
23
- }): Promise<import("axios").AxiosResponse<any, any>>;
24
- getOfflineAccessToken(scopes: any, code: any): Promise<import("axios").AxiosResponse<any, any>>;
25
- getOfflineAccessTokenObj(scopes: any, code: any): Promise<import("axios").AxiosResponse<any, any>>;
23
+ }): Promise<import("sdk/node_modules/axios").AxiosResponse<any, any>>;
24
+ getOfflineAccessToken(scopes: any, code: any): Promise<import("sdk/node_modules/axios").AxiosResponse<any, any>>;
25
+ getOfflineAccessTokenObj(scopes: any, code: any): Promise<import("sdk/node_modules/axios").AxiosResponse<any, any>>;
26
26
  }
@@ -9,8 +9,8 @@ declare class Order {
9
9
  * @param {import("../PlatformAPIClient").Options} - Options
10
10
  * @returns {Promise<OrderPlatformModel.FailedOrderLogs>} - Success response
11
11
  * @name failedOrderLogs
12
- * @summary: Get failed order logs according to the filter provided
13
- * @description: This endpoint allows users to 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/).
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
14
  */
15
15
  failedOrderLogs({ pageNo, pageSize, searchType, searchValue, requestHeaders }?: OrderPlatformApplicationValidator.FailedOrderLogsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.FailedOrderLogs>;
16
16
  /**
@@ -23,8 +23,8 @@ declare class Order {
23
23
  * - Success response
24
24
  *
25
25
  * @name getApplicationShipments
26
- * @summary:
27
- * @description: Get cross selling platform shipments - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getApplicationShipments/).
26
+ * @summary: List sales channel shipments
27
+ * @description: Get shipments of a particular sales channel based on the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getApplicationShipments/).
28
28
  */
29
29
  getApplicationShipments({ lane, searchType, searchId, fromDate, toDate, dpIds, orderingCompanyId, stores, salesChannel, requestByExt, pageNo, pageSize, customerId, isPrioritySort, excludeLockedShipments, requestHeaders, }?: OrderPlatformApplicationValidator.GetApplicationShipmentsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentInternalPlatformViewResponse>;
30
30
  /**
@@ -35,8 +35,8 @@ declare class Order {
35
35
  * @param {import("../PlatformAPIClient").Options} - Options
36
36
  * @returns {Promise<OrderPlatformModel.ShipmentReasonsResponse>} - Success response
37
37
  * @name getPlatformShipmentReasons
38
- * @summary: Get platform shipment reasons
39
- * @description: Retrieve reasons behind full or partial cancellation of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getPlatformShipmentReasons/).
38
+ * @summary: List shipment cancellation reasons
39
+ * @description: Get reasons to perform full or partial cancellation of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getPlatformShipmentReasons/).
40
40
  */
41
41
  getPlatformShipmentReasons({ action, requestHeaders }?: OrderPlatformApplicationValidator.GetPlatformShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentReasonsResponse>;
42
42
  /**
@@ -47,8 +47,8 @@ declare class Order {
47
47
  * @param {import("../PlatformAPIClient").Options} - Options
48
48
  * @returns {Promise<OrderPlatformModel.ShipmentBagReasons>} - Success response
49
49
  * @name getShipmentBagReasons
50
- * @summary: Get reasons behind full or partial cancellation of a shipment
51
- * @description: Use this API to retrieve the issues that led to the cancellation of bags within a shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentBagReasons/).
50
+ * @summary: List bag cancellation reasons
51
+ * @description: Get reasons to perform full or partial cancellation of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentBagReasons/).
52
52
  */
53
53
  getShipmentBagReasons({ shipmentId, lineNumber, requestHeaders }?: OrderPlatformApplicationValidator.GetShipmentBagReasonsParam, { responseHeaders }?: object): Promise<OrderPlatformModel.ShipmentBagReasons>;
54
54
  /**
@@ -59,10 +59,10 @@ declare class Order {
59
59
  * @param {import("../PlatformAPIClient").Options} - Options
60
60
  * @returns {Promise<OrderPlatformModel.PlatformShipmentTrack>} - Success response
61
61
  * @name trackShipmentPlatform
62
- * @summary: Track shipment on the platform
63
- * @description: Track shipment by Shipment ID for application based on application Id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/trackShipmentPlatform/).
62
+ * @summary: Track shipment
63
+ * @description: Track shipment by shipment Id for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/trackShipmentPlatform/).
64
64
  */
65
65
  trackShipmentPlatform({ shipmentId, requestHeaders }?: OrderPlatformApplicationValidator.TrackShipmentPlatformParam, { responseHeaders }?: object): Promise<OrderPlatformModel.PlatformShipmentTrack>;
66
66
  }
67
- import OrderPlatformApplicationValidator = require("./OrderPlatformApplicationValidator");
68
- import OrderPlatformModel = require("./OrderPlatformModel");
67
+ import OrderPlatformApplicationValidator = require("sdk/output/javascript/code/sdk/platform/Order/OrderPlatformApplicationValidator");
68
+ import OrderPlatformModel = require("sdk/output/javascript/code/sdk/platform/Order/OrderPlatformModel");
@@ -21,8 +21,8 @@ class Order {
21
21
  * @param {import("../PlatformAPIClient").Options} - Options
22
22
  * @returns {Promise<OrderPlatformModel.FailedOrderLogs>} - Success response
23
23
  * @name failedOrderLogs
24
- * @summary: Get failed order logs according to the filter provided
25
- * @description: This endpoint allows users to 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/).
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
26
  */
27
27
  async failedOrderLogs(
28
28
  { pageNo, pageSize, searchType, searchValue, requestHeaders } = {
@@ -117,8 +117,8 @@ class Order {
117
117
  * - Success response
118
118
  *
119
119
  * @name getApplicationShipments
120
- * @summary:
121
- * @description: Get cross selling platform shipments - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getApplicationShipments/).
120
+ * @summary: List sales channel shipments
121
+ * @description: Get shipments of a particular sales channel based on the filters provided - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getApplicationShipments/).
122
122
  */
123
123
  async getApplicationShipments(
124
124
  {
@@ -258,8 +258,8 @@ class Order {
258
258
  * @param {import("../PlatformAPIClient").Options} - Options
259
259
  * @returns {Promise<OrderPlatformModel.ShipmentReasonsResponse>} - Success response
260
260
  * @name getPlatformShipmentReasons
261
- * @summary: Get platform shipment reasons
262
- * @description: Retrieve reasons behind full or partial cancellation of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getPlatformShipmentReasons/).
261
+ * @summary: List shipment cancellation reasons
262
+ * @description: Get reasons to perform full or partial cancellation of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getPlatformShipmentReasons/).
263
263
  */
264
264
  async getPlatformShipmentReasons(
265
265
  { action, requestHeaders } = { requestHeaders: {} },
@@ -339,8 +339,8 @@ class Order {
339
339
  * @param {import("../PlatformAPIClient").Options} - Options
340
340
  * @returns {Promise<OrderPlatformModel.ShipmentBagReasons>} - Success response
341
341
  * @name getShipmentBagReasons
342
- * @summary: Get reasons behind full or partial cancellation of a shipment
343
- * @description: Use this API to retrieve the issues that led to the cancellation of bags within a shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentBagReasons/).
342
+ * @summary: List bag cancellation reasons
343
+ * @description: Get reasons to perform full or partial cancellation of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/getShipmentBagReasons/).
344
344
  */
345
345
  async getShipmentBagReasons(
346
346
  { shipmentId, lineNumber, requestHeaders } = { requestHeaders: {} },
@@ -422,8 +422,8 @@ class Order {
422
422
  * @param {import("../PlatformAPIClient").Options} - Options
423
423
  * @returns {Promise<OrderPlatformModel.PlatformShipmentTrack>} - Success response
424
424
  * @name trackShipmentPlatform
425
- * @summary: Track shipment on the platform
426
- * @description: Track shipment by Shipment ID for application based on application Id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/trackShipmentPlatform/).
425
+ * @summary: Track shipment
426
+ * @description: Track shipment by shipment Id for an application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/order/trackShipmentPlatform/).
427
427
  */
428
428
  async trackShipmentPlatform(
429
429
  { shipmentId, requestHeaders } = { requestHeaders: {} },