@gofynd/fdk-client-javascript 1.4.2-beta.3 → 1.4.2-beta.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (152) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +62 -62
  4. package/sdk/application/Cart/CartApplicationClient.js +82 -71
  5. package/sdk/application/Cart/CartApplicationValidator.d.ts +189 -34
  6. package/sdk/application/Cart/CartApplicationValidator.js +59 -34
  7. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +78 -78
  8. package/sdk/application/Catalog/CatalogApplicationClient.js +78 -78
  9. package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
  10. package/sdk/application/Common/CommonApplicationClient.js +4 -4
  11. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
  12. package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
  13. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -67
  14. package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -106
  15. package/sdk/application/Content/ContentApplicationClient.d.ts +34 -64
  16. package/sdk/application/Content/ContentApplicationClient.js +34 -115
  17. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -42
  18. package/sdk/application/FileStorage/FileStorageApplicationClient.js +6 -42
  19. package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -14
  20. package/sdk/application/Lead/LeadApplicationClient.js +14 -14
  21. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +12 -12
  22. package/sdk/application/Logistic/LogisticApplicationClient.js +12 -12
  23. package/sdk/application/Order/OrderApplicationClient.d.ts +24 -24
  24. package/sdk/application/Order/OrderApplicationClient.js +24 -24
  25. package/sdk/application/Order/OrderApplicationModel.d.ts +29 -1
  26. package/sdk/application/Order/OrderApplicationModel.js +34 -0
  27. package/sdk/application/Payment/PaymentApplicationClient.d.ts +89 -89
  28. package/sdk/application/Payment/PaymentApplicationClient.js +94 -94
  29. package/sdk/application/Payment/PaymentApplicationModel.d.ts +524 -3
  30. package/sdk/application/Payment/PaymentApplicationModel.js +335 -2
  31. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
  32. package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
  33. package/sdk/application/PosCart/PosCartApplicationClient.d.ts +54 -54
  34. package/sdk/application/PosCart/PosCartApplicationClient.js +54 -54
  35. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +14 -25
  36. package/sdk/application/Rewards/RewardsApplicationClient.js +14 -41
  37. package/sdk/application/Share/ShareApplicationClient.d.ts +14 -14
  38. package/sdk/application/Share/ShareApplicationClient.js +14 -14
  39. package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
  40. package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
  41. package/sdk/application/User/UserApplicationClient.d.ts +66 -66
  42. package/sdk/application/User/UserApplicationClient.js +68 -71
  43. package/sdk/application/User/UserApplicationModel.d.ts +32 -27
  44. package/sdk/application/User/UserApplicationModel.js +22 -32
  45. package/sdk/partner/Theme/ThemePartnerClient.d.ts +38 -38
  46. package/sdk/partner/Theme/ThemePartnerClient.js +38 -38
  47. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -8
  48. package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +8 -8
  49. package/sdk/platform/Billing/BillingPlatformClient.d.ts +34 -36
  50. package/sdk/platform/Billing/BillingPlatformClient.js +34 -36
  51. package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +98 -175
  52. package/sdk/platform/Cart/CartPlatformApplicationClient.js +98 -254
  53. package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +92 -18
  54. package/sdk/platform/Cart/CartPlatformApplicationValidator.js +28 -18
  55. package/sdk/platform/Cart/CartPlatformModel.d.ts +12 -0
  56. package/sdk/platform/Cart/CartPlatformModel.js +12 -0
  57. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +221 -108
  58. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +460 -113
  59. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +72 -3
  60. package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +46 -2
  61. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +335 -136
  62. package/sdk/platform/Catalog/CatalogPlatformClient.js +551 -136
  63. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +38 -5
  64. package/sdk/platform/Catalog/CatalogPlatformModel.js +47 -3
  65. package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -3
  66. package/sdk/platform/Common/CommonPlatformClient.js +3 -3
  67. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +115 -290
  68. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +115 -510
  69. package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -13
  70. package/sdk/platform/Communication/CommunicationPlatformClient.js +2 -29
  71. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +32 -32
  72. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +32 -32
  73. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +52 -127
  74. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +52 -204
  75. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +35 -111
  76. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +35 -212
  77. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +142 -1
  78. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +96 -0
  79. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +130 -218
  80. package/sdk/platform/Content/ContentPlatformApplicationClient.js +136 -314
  81. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +4 -4
  82. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +4 -4
  83. package/sdk/platform/Content/ContentPlatformClient.d.ts +1 -1
  84. package/sdk/platform/Content/ContentPlatformClient.js +7 -7
  85. package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -1
  86. package/sdk/platform/Content/ContentPlatformModel.js +20 -0
  87. package/sdk/platform/Content/ContentPlatformValidator.d.ts +4 -4
  88. package/sdk/platform/Content/ContentPlatformValidator.js +4 -4
  89. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +22 -48
  90. package/sdk/platform/Discount/DiscountPlatformClient.js +22 -73
  91. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +20 -56
  92. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +23 -56
  93. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +2 -0
  94. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +2 -0
  95. package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +12 -48
  96. package/sdk/platform/FileStorage/FileStoragePlatformClient.js +12 -48
  97. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +15 -1
  98. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +14 -0
  99. package/sdk/platform/Finance/FinancePlatformClient.d.ts +44 -44
  100. package/sdk/platform/Finance/FinancePlatformClient.js +44 -44
  101. package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
  102. package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
  103. package/sdk/platform/Lead/LeadPlatformClient.d.ts +22 -48
  104. package/sdk/platform/Lead/LeadPlatformClient.js +22 -72
  105. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -4
  106. package/sdk/platform/Order/OrderPlatformApplicationClient.js +4 -4
  107. package/sdk/platform/Order/OrderPlatformClient.d.ts +79 -208
  108. package/sdk/platform/Order/OrderPlatformClient.js +79 -294
  109. package/sdk/platform/Order/OrderPlatformModel.d.ts +42 -1
  110. package/sdk/platform/Order/OrderPlatformModel.js +44 -0
  111. package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
  112. package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
  113. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +4 -4
  114. package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +2 -2
  115. package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +81 -81
  116. package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +81 -81
  117. package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
  118. package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
  119. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +27 -1
  120. package/sdk/platform/Payment/PaymentPlatformModel.js +19 -0
  121. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +23 -40
  122. package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +23 -61
  123. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +8 -8
  124. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +8 -8
  125. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +10 -9
  126. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +11 -10
  127. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +170 -33
  128. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +171 -38
  129. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +2 -2
  130. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +2 -2
  131. package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +11 -11
  132. package/sdk/platform/Share/SharePlatformApplicationClient.js +29 -16
  133. package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +13 -3
  134. package/sdk/platform/Share/SharePlatformApplicationValidator.js +6 -2
  135. package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +56 -56
  136. package/sdk/platform/Theme/ThemePlatformApplicationClient.js +56 -56
  137. package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
  138. package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
  139. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +33 -33
  140. package/sdk/platform/User/UserPlatformApplicationClient.js +33 -33
  141. package/sdk/platform/User/UserPlatformModel.d.ts +81 -11
  142. package/sdk/platform/User/UserPlatformModel.js +80 -10
  143. package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +32 -45
  144. package/sdk/platform/Webhook/WebhookPlatformClient.js +32 -45
  145. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +58 -1
  146. package/sdk/platform/Webhook/WebhookPlatformModel.js +66 -0
  147. package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
  148. package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
  149. package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
  150. package/sdk/public/Partner/PartnerPublicClient.js +2 -2
  151. package/sdk/public/Webhook/WebhookPublicClient.d.ts +4 -4
  152. package/sdk/public/Webhook/WebhookPublicClient.js +4 -4
@@ -43,26 +43,8 @@ class FileStorage {
43
43
  * @param {import("../ApplicationAPIClient").Options} - Options
44
44
  * @returns {Promise<FileStorageApplicationModel.CompleteResponse>} - Success response
45
45
  * @name completeUpload
46
- * @summary: Completes the upload process. After successfully uploading a file, call this API to finish the upload process.
47
- * @description: Use this API to perform the third step of uploading (i.e. **Complete**) an arbitrarily sized buffer or blob.
48
- *
49
- * The three major steps are:
50
- * Start
51
- * Upload
52
- * Complete
53
- *
54
- * ### Start
55
- * Initiates the assets upload using `startUpload`.
56
- * It returns a storage link in response.
57
- *
58
- * ### Upload
59
- * Use the storage link to upload a file (Buffer or Blob) to the File Storage.
60
- * Make a `PUT` request on storage link received from `startUpload` API with the file (Buffer or Blob) in the request body.
61
- *
62
- * ### Complete
63
- * After successfully upload, call the `completeUpload` API to finish the upload process.
64
- * This operation will return the URL of the uploaded file.
65
- * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/completeUpload/).
46
+ * @summary: Finalizes upload process.
47
+ * @description: Complete the process of uploading the file, and will return the URL of the uploaded file - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/completeUpload/).
66
48
  */
67
49
  async completeUpload(
68
50
  { namespace, body, requestHeaders } = { requestHeaders: {} },
@@ -139,8 +121,8 @@ class FileStorage {
139
121
  * @param {import("../ApplicationAPIClient").Options} - Options
140
122
  * @returns {Promise<FileStorageApplicationModel.SignUrlResponse>} - Success response
141
123
  * @name signUrls
142
- * @summary: Explain here
143
- * @description: Describe here - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/signUrls/).
124
+ * @summary: Signs file URLs.
125
+ * @description: Generates secure, signed URLs that is valid for certain expiry time for accessing stored files. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/signUrls/).
144
126
  */
145
127
  async signUrls(
146
128
  { body, requestHeaders } = { requestHeaders: {} },
@@ -217,26 +199,8 @@ class FileStorage {
217
199
  * @param {import("../ApplicationAPIClient").Options} - Options
218
200
  * @returns {Promise<FileStorageApplicationModel.StartResponse>} - Success response
219
201
  * @name startUpload
220
- * @summary: Initiates an upload and returns a storage link that is valid for 30 minutes. You can use the storage link to make subsequent upload request with file buffer or blob.
221
- * @description: Use this API to perform the first step of uploading (i.e. **Start**) an arbitrarily sized buffer or blob.
222
- *
223
- * The three major steps are:
224
- * Start
225
- * Upload
226
- * Complete
227
- *
228
- * ### Start
229
- * Initiates the assets upload using `startUpload`.
230
- * It returns a storage link in response.
231
- *
232
- * ### Upload
233
- * Use the storage link to upload a file (Buffer or Blob) to the File Storage.
234
- * Make a `PUT` request on storage link received from `startUpload` API with the file (Buffer or Blob) in the request body.
235
- *
236
- * ### Complete
237
- * After successfully upload, call the `completeUpload` API to finish the upload process.
238
- * This operation will return the URL of the uploaded file.
239
- * - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/startUpload/).
202
+ * @summary: Initiates file upload
203
+ * @description: Starts the process of uploading a file to storage location, and returns a storage link in response. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/startUpload/).
240
204
  */
241
205
  async startUpload(
242
206
  { namespace, body, requestHeaders } = { requestHeaders: {} },
@@ -19,8 +19,8 @@ declare class Lead {
19
19
  * @param {import("../ApplicationAPIClient").Options} - Options
20
20
  * @returns {Promise<LeadApplicationModel.TicketHistory>} - Success response
21
21
  * @name createHistory
22
- * @summary: Create history for specific Ticket
23
- * @description: Create history for specific 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/application/lead/createHistory/).
22
+ * @summary: Logs ticket history.
23
+ * @description: Adds a history entry for a specific support ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/createHistory/).
24
24
  */
25
25
  createHistory({ id, body, requestHeaders }?: LeadApplicationValidator.CreateHistoryParam, { responseHeaders }?: object): Promise<LeadApplicationModel.TicketHistory>;
26
26
  /**
@@ -29,8 +29,8 @@ declare class Lead {
29
29
  * @param {import("../ApplicationAPIClient").Options} - Options
30
30
  * @returns {Promise<LeadApplicationModel.Ticket>} - Success response
31
31
  * @name createTicket
32
- * @summary: Create Ticket
33
- * @description: This is used to Create Ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/createTicket/).
32
+ * @summary: Creates a new ticket.
33
+ * @description: Generates a new customer support ticket for a user query. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/createTicket/).
34
34
  */
35
35
  createTicket({ body, requestHeaders }?: LeadApplicationValidator.CreateTicketParam, { responseHeaders }?: object): Promise<LeadApplicationModel.Ticket>;
36
36
  /**
@@ -39,8 +39,8 @@ declare class Lead {
39
39
  * @param {import("../ApplicationAPIClient").Options} - Options
40
40
  * @returns {Promise<LeadApplicationModel.CustomForm>} - Success response
41
41
  * @name getCustomForm
42
- * @summary: Get specific Custom Form using it's slug
43
- * @description: Get specific Custom Form using it's slug, this is used to view the form. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getCustomForm/).
42
+ * @summary: Fetches custom form.
43
+ * @description: Retrieves a customizable form template for data collection. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getCustomForm/).
44
44
  */
45
45
  getCustomForm({ slug, requestHeaders }?: LeadApplicationValidator.GetCustomFormParam, { responseHeaders }?: object): Promise<LeadApplicationModel.CustomForm>;
46
46
  /**
@@ -53,8 +53,8 @@ declare class Lead {
53
53
  * - Success response
54
54
  *
55
55
  * @name getParticipantsInsideVideoRoom
56
- * @summary: Get participants of a specific Video Room using it's unique name
57
- * @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/application/lead/getParticipantsInsideVideoRoom/).
56
+ * @summary: Lists video room participants.
57
+ * @description: Gets the current participants inside a specific video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getParticipantsInsideVideoRoom/).
58
58
  */
59
59
  getParticipantsInsideVideoRoom({ uniqueName, requestHeaders }?: LeadApplicationValidator.GetParticipantsInsideVideoRoomParam, { responseHeaders }?: object): Promise<LeadApplicationModel.GetParticipantsInsideVideoRoomResponse>;
60
60
  /**
@@ -63,8 +63,8 @@ declare class Lead {
63
63
  * @param {import("../ApplicationAPIClient").Options} - Options
64
64
  * @returns {Promise<LeadApplicationModel.Ticket>} - Success response
65
65
  * @name getTicket
66
- * @summary: Get Ticket with the specific id
67
- * @description: Get Ticket with the specific id, this is used to view the ticket details - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getTicket/).
66
+ * @summary: Retrieves a support ticket.
67
+ * @description: Retrieve details of a specific customer support ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getTicket/).
68
68
  */
69
69
  getTicket({ id, requestHeaders }?: LeadApplicationValidator.GetTicketParam, { responseHeaders }?: object): Promise<LeadApplicationModel.Ticket>;
70
70
  /**
@@ -74,8 +74,8 @@ declare class Lead {
74
74
  * @returns {Promise<LeadApplicationModel.GetTokenForVideoRoomResponse>} -
75
75
  * Success response
76
76
  * @name getTokenForVideoRoom
77
- * @summary: Get Token to join a specific Video Room using it's unqiue name
78
- * @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/application/lead/getTokenForVideoRoom/).
77
+ * @summary: Retrieves video room token.
78
+ * @description: Retrieves a secure token for accessing a video chat room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getTokenForVideoRoom/).
79
79
  */
80
80
  getTokenForVideoRoom({ uniqueName, requestHeaders }?: LeadApplicationValidator.GetTokenForVideoRoomParam, { responseHeaders }?: object): Promise<LeadApplicationModel.GetTokenForVideoRoomResponse>;
81
81
  /**
@@ -85,8 +85,8 @@ declare class Lead {
85
85
  * @returns {Promise<LeadApplicationModel.SubmitCustomFormResponse>} -
86
86
  * Success response
87
87
  * @name submitCustomForm
88
- * @summary: Submit Response for a specific Custom Form using it's slug
89
- * @description: Submit Response for a specific Custom Form using it's slug, this response is then used to create a ticket on behalf of the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/submitCustomForm/).
88
+ * @summary: Submits form data.
89
+ * @description: Sends user-entered data from a custom form for processing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/submitCustomForm/).
90
90
  */
91
91
  submitCustomForm({ slug, body, requestHeaders }?: LeadApplicationValidator.SubmitCustomFormParam, { responseHeaders }?: object): Promise<LeadApplicationModel.SubmitCustomFormResponse>;
92
92
  }
@@ -46,8 +46,8 @@ class Lead {
46
46
  * @param {import("../ApplicationAPIClient").Options} - Options
47
47
  * @returns {Promise<LeadApplicationModel.TicketHistory>} - Success response
48
48
  * @name createHistory
49
- * @summary: Create history for specific Ticket
50
- * @description: Create history for specific 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/application/lead/createHistory/).
49
+ * @summary: Logs ticket history.
50
+ * @description: Adds a history entry for a specific support ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/createHistory/).
51
51
  */
52
52
  async createHistory(
53
53
  { id, body, requestHeaders } = { requestHeaders: {} },
@@ -124,8 +124,8 @@ class Lead {
124
124
  * @param {import("../ApplicationAPIClient").Options} - Options
125
125
  * @returns {Promise<LeadApplicationModel.Ticket>} - Success response
126
126
  * @name createTicket
127
- * @summary: Create Ticket
128
- * @description: This is used to Create Ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/createTicket/).
127
+ * @summary: Creates a new ticket.
128
+ * @description: Generates a new customer support ticket for a user query. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/createTicket/).
129
129
  */
130
130
  async createTicket(
131
131
  { body, requestHeaders } = { requestHeaders: {} },
@@ -202,8 +202,8 @@ class Lead {
202
202
  * @param {import("../ApplicationAPIClient").Options} - Options
203
203
  * @returns {Promise<LeadApplicationModel.CustomForm>} - Success response
204
204
  * @name getCustomForm
205
- * @summary: Get specific Custom Form using it's slug
206
- * @description: Get specific Custom Form using it's slug, this is used to view the form. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getCustomForm/).
205
+ * @summary: Fetches custom form.
206
+ * @description: Retrieves a customizable form template for data collection. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getCustomForm/).
207
207
  */
208
208
  async getCustomForm(
209
209
  { slug, requestHeaders } = { requestHeaders: {} },
@@ -284,8 +284,8 @@ class Lead {
284
284
  * - Success response
285
285
  *
286
286
  * @name getParticipantsInsideVideoRoom
287
- * @summary: Get participants of a specific Video Room using it's unique name
288
- * @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/application/lead/getParticipantsInsideVideoRoom/).
287
+ * @summary: Lists video room participants.
288
+ * @description: Gets the current participants inside a specific video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getParticipantsInsideVideoRoom/).
289
289
  */
290
290
  async getParticipantsInsideVideoRoom(
291
291
  { uniqueName, requestHeaders } = { requestHeaders: {} },
@@ -364,8 +364,8 @@ class Lead {
364
364
  * @param {import("../ApplicationAPIClient").Options} - Options
365
365
  * @returns {Promise<LeadApplicationModel.Ticket>} - Success response
366
366
  * @name getTicket
367
- * @summary: Get Ticket with the specific id
368
- * @description: Get Ticket with the specific id, this is used to view the ticket details - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getTicket/).
367
+ * @summary: Retrieves a support ticket.
368
+ * @description: Retrieve details of a specific customer support ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getTicket/).
369
369
  */
370
370
  async getTicket(
371
371
  { id, requestHeaders } = { requestHeaders: {} },
@@ -441,8 +441,8 @@ class Lead {
441
441
  * @returns {Promise<LeadApplicationModel.GetTokenForVideoRoomResponse>} -
442
442
  * Success response
443
443
  * @name getTokenForVideoRoom
444
- * @summary: Get Token to join a specific Video Room using it's unqiue name
445
- * @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/application/lead/getTokenForVideoRoom/).
444
+ * @summary: Retrieves video room token.
445
+ * @description: Retrieves a secure token for accessing a video chat room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getTokenForVideoRoom/).
446
446
  */
447
447
  async getTokenForVideoRoom(
448
448
  { uniqueName, requestHeaders } = { requestHeaders: {} },
@@ -520,8 +520,8 @@ class Lead {
520
520
  * @returns {Promise<LeadApplicationModel.SubmitCustomFormResponse>} -
521
521
  * Success response
522
522
  * @name submitCustomForm
523
- * @summary: Submit Response for a specific Custom Form using it's slug
524
- * @description: Submit Response for a specific Custom Form using it's slug, this response is then used to create a ticket on behalf of the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/submitCustomForm/).
523
+ * @summary: Submits form data.
524
+ * @description: Sends user-entered data from a custom form for processing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/submitCustomForm/).
525
525
  */
526
526
  async submitCustomForm(
527
527
  { slug, body, requestHeaders } = { requestHeaders: {} },
@@ -23,8 +23,8 @@ declare class Logistic {
23
23
  * @param {import("../ApplicationAPIClient").Options} - Options
24
24
  * @returns {Promise<LogisticApplicationModel.CountryListResponse>} - Success response
25
25
  * @name getAllCountries
26
- * @summary: Get Country List
27
- * @description: Get all countries - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getAllCountries/).
26
+ * @summary: Lists all countries.
27
+ * @description: Retrieve a list of all countries supported by the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getAllCountries/).
28
28
  */
29
29
  getAllCountries({ requestHeaders }?: any, { responseHeaders }?: object): Promise<LogisticApplicationModel.CountryListResponse>;
30
30
  /**
@@ -73,8 +73,8 @@ declare class Logistic {
73
73
  * @param {import("../ApplicationAPIClient").Options} - Options
74
74
  * @returns {Promise<LogisticApplicationModel.GetStoreResponse>} - Success response
75
75
  * @name getLocations
76
- * @summary: GET locations from the Pincode.
77
- * @description: This API returns store from the Pincode View. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocations/).
76
+ * @summary: Fetches available locations.
77
+ * @description: Retrieves a list of all locations of countries, states, cities. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocations/).
78
78
  */
79
79
  getLocations({ xApplicationId, xApplicationData, country, state, city, pincode, sector, pageNo, pageSize, requestHeaders, }?: LogisticApplicationValidator.GetLocationsParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.GetStoreResponse>;
80
80
  /**
@@ -84,8 +84,8 @@ declare class Logistic {
84
84
  * @returns {Promise<LogisticApplicationModel.ReAssignStoreResponse>} -
85
85
  * Success response
86
86
  * @name getOptimalLocations
87
- * @summary: GET zone from the Pincode.
88
- * @description: This API returns zone from the Pincode View. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getOptimalLocations/).
87
+ * @summary: Finds optimal locations.
88
+ * @description: Retrieve the most efficient locations for logistics purposes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getOptimalLocations/).
89
89
  */
90
90
  getOptimalLocations({ body, requestHeaders }?: LogisticApplicationValidator.GetOptimalLocationsParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.ReAssignStoreResponse>;
91
91
  /**
@@ -94,8 +94,8 @@ declare class Logistic {
94
94
  * @param {import("../ApplicationAPIClient").Options} - Options
95
95
  * @returns {Promise<LogisticApplicationModel.PincodeApiResponse>} - Success response
96
96
  * @name getPincodeCity
97
- * @summary: Get Pincode API
98
- * @description: Get pincode data - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeCity/).
97
+ * @summary: Fetches city by pincode.
98
+ * @description: Retrieve the name of the city associated with a given pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeCity/).
99
99
  */
100
100
  getPincodeCity({ pincode, requestHeaders }?: LogisticApplicationValidator.GetPincodeCityParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.PincodeApiResponse>;
101
101
  /**
@@ -106,8 +106,8 @@ declare class Logistic {
106
106
  * - Success response
107
107
  *
108
108
  * @name getPincodeZones
109
- * @summary: GET zone from the Pincode.
110
- * @description: This API returns zone from the Pincode View. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeZones/).
109
+ * @summary: Fetches zones by pincode.
110
+ * @description: Retreive the logistical zones corresponding to a given pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeZones/).
111
111
  */
112
112
  getPincodeZones({ body, requestHeaders }?: LogisticApplicationValidator.GetPincodeZonesParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.GetZoneFromPincodeViewResponse>;
113
113
  /**
@@ -116,8 +116,8 @@ declare class Logistic {
116
116
  * @param {import("../ApplicationAPIClient").Options} - Options
117
117
  * @returns {Promise<LogisticApplicationModel.TATViewResponse>} - Success response
118
118
  * @name getTatProduct
119
- * @summary: Get TAT API
120
- * @description: Get TAT data - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getTatProduct/).
119
+ * @summary: Retrieves product turnaround time.
120
+ * @description: Retrieve the estimated delivery time for a specific product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getTatProduct/).
121
121
  */
122
122
  getTatProduct({ body, requestHeaders }?: LogisticApplicationValidator.GetTatProductParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.TATViewResponse>;
123
123
  /**
@@ -53,8 +53,8 @@ class Logistic {
53
53
  * @param {import("../ApplicationAPIClient").Options} - Options
54
54
  * @returns {Promise<LogisticApplicationModel.CountryListResponse>} - Success response
55
55
  * @name getAllCountries
56
- * @summary: Get Country List
57
- * @description: Get all countries - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getAllCountries/).
56
+ * @summary: Lists all countries.
57
+ * @description: Retrieve a list of all countries supported by the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getAllCountries/).
58
58
  */
59
59
  async getAllCountries(
60
60
  { requestHeaders } = { requestHeaders: {} },
@@ -469,8 +469,8 @@ class Logistic {
469
469
  * @param {import("../ApplicationAPIClient").Options} - Options
470
470
  * @returns {Promise<LogisticApplicationModel.GetStoreResponse>} - Success response
471
471
  * @name getLocations
472
- * @summary: GET locations from the Pincode.
473
- * @description: This API returns store from the Pincode View. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocations/).
472
+ * @summary: Fetches available locations.
473
+ * @description: Retrieves a list of all locations of countries, states, cities. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocations/).
474
474
  */
475
475
  async getLocations(
476
476
  {
@@ -588,8 +588,8 @@ class Logistic {
588
588
  * @returns {Promise<LogisticApplicationModel.ReAssignStoreResponse>} -
589
589
  * Success response
590
590
  * @name getOptimalLocations
591
- * @summary: GET zone from the Pincode.
592
- * @description: This API returns zone from the Pincode View. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getOptimalLocations/).
591
+ * @summary: Finds optimal locations.
592
+ * @description: Retrieve the most efficient locations for logistics purposes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getOptimalLocations/).
593
593
  */
594
594
  async getOptimalLocations(
595
595
  { body, requestHeaders } = { requestHeaders: {} },
@@ -668,8 +668,8 @@ class Logistic {
668
668
  * @param {import("../ApplicationAPIClient").Options} - Options
669
669
  * @returns {Promise<LogisticApplicationModel.PincodeApiResponse>} - Success response
670
670
  * @name getPincodeCity
671
- * @summary: Get Pincode API
672
- * @description: Get pincode data - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeCity/).
671
+ * @summary: Fetches city by pincode.
672
+ * @description: Retrieve the name of the city associated with a given pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeCity/).
673
673
  */
674
674
  async getPincodeCity(
675
675
  { pincode, requestHeaders } = { requestHeaders: {} },
@@ -748,8 +748,8 @@ class Logistic {
748
748
  * - Success response
749
749
  *
750
750
  * @name getPincodeZones
751
- * @summary: GET zone from the Pincode.
752
- * @description: This API returns zone from the Pincode View. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeZones/).
751
+ * @summary: Fetches zones by pincode.
752
+ * @description: Retreive the logistical zones corresponding to a given pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeZones/).
753
753
  */
754
754
  async getPincodeZones(
755
755
  { body, requestHeaders } = { requestHeaders: {} },
@@ -826,8 +826,8 @@ class Logistic {
826
826
  * @param {import("../ApplicationAPIClient").Options} - Options
827
827
  * @returns {Promise<LogisticApplicationModel.TATViewResponse>} - Success response
828
828
  * @name getTatProduct
829
- * @summary: Get TAT API
830
- * @description: Get TAT data - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getTatProduct/).
829
+ * @summary: Retrieves product turnaround time.
830
+ * @description: Retrieve the estimated delivery time for a specific product. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getTatProduct/).
831
831
  */
832
832
  async getTatProduct(
833
833
  { body, requestHeaders } = { requestHeaders: {} },
@@ -27,8 +27,8 @@ declare class Order {
27
27
  * @returns {Promise<OrderApplicationModel.CustomerDetailsResponse>} -
28
28
  * Success response
29
29
  * @name getCustomerDetailsByShipmentId
30
- * @summary: Get Customer Details by Shipment Id
31
- * @description: Use this API to retrieve customer details such as mobileno using Shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getCustomerDetailsByShipmentId/).
30
+ * @summary: Retrieves shipment customer.
31
+ * @description: Retrieve customer details such as mobile number using Shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getCustomerDetailsByShipmentId/).
32
32
  */
33
33
  getCustomerDetailsByShipmentId({ orderId, shipmentId, requestHeaders }?: OrderApplicationValidator.GetCustomerDetailsByShipmentIdParam, { responseHeaders }?: object): Promise<OrderApplicationModel.CustomerDetailsResponse>;
34
34
  /**
@@ -38,8 +38,8 @@ declare class Order {
38
38
  * @returns {Promise<OrderApplicationModel.ResponseGetInvoiceShipment>} -
39
39
  * Success response
40
40
  * @name getInvoiceByShipmentId
41
- * @summary: Get Invoice of a shipment
42
- * @description: Use this API to retrieve shipment invoice. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getInvoiceByShipmentId/).
41
+ * @summary: Retrieves invoice for shipment.
42
+ * @description: Retrieve the invoice corresponding to a specific shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getInvoiceByShipmentId/).
43
43
  */
44
44
  getInvoiceByShipmentId({ shipmentId, requestHeaders }?: OrderApplicationValidator.GetInvoiceByShipmentIdParam, { responseHeaders }?: object): Promise<OrderApplicationModel.ResponseGetInvoiceShipment>;
45
45
  /**
@@ -48,8 +48,8 @@ declare class Order {
48
48
  * @param {import("../ApplicationAPIClient").Options} - Options
49
49
  * @returns {Promise<OrderApplicationModel.OrderById>} - Success response
50
50
  * @name getOrderById
51
- * @summary: Get details of an order
52
- * @description: Use this API to retrieve order details such as tracking details, shipment, store information using Fynd Order ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getOrderById/).
51
+ * @summary: Fetches order by ID.
52
+ * @description: Retrieve order details such as tracking details, shipment, store information using Fynd Order ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getOrderById/).
53
53
  */
54
54
  getOrderById({ orderId, allowInactive, requestHeaders }?: OrderApplicationValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderApplicationModel.OrderById>;
55
55
  /**
@@ -58,8 +58,8 @@ declare class Order {
58
58
  * @param {import("../ApplicationAPIClient").Options} - Options
59
59
  * @returns {Promise<OrderApplicationModel.OrderList>} - Success response
60
60
  * @name getOrders
61
- * @summary: Get all orders
62
- * @description: Use this API to retrieve all the orders. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getOrders/).
61
+ * @summary: Lists customer orders.
62
+ * @description: Retrieves all orders associated with a customer account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getOrders/).
63
63
  */
64
64
  getOrders({ status, pageNo, pageSize, fromDate, toDate, startDate, endDate, customMeta, requestHeaders, }?: OrderApplicationValidator.GetOrdersParam, { responseHeaders }?: object): Promise<OrderApplicationModel.OrderList>;
65
65
  /**
@@ -68,8 +68,8 @@ declare class Order {
68
68
  * @param {import("../ApplicationAPIClient").Options} - Options
69
69
  * @returns {Promise<OrderApplicationModel.OrderById>} - Success response
70
70
  * @name getPosOrderById
71
- * @summary: Get POS Order
72
- * @description: Use this API to retrieve a POS order and all its details such as tracking details, shipment, store information using Fynd Order ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getPosOrderById/).
71
+ * @summary: Retrieves POS order details.
72
+ * @description: Retrieve a POS order and all its details such as tracking details, shipment, store information using Fynd Order ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getPosOrderById/).
73
73
  */
74
74
  getPosOrderById({ orderId, requestHeaders }?: OrderApplicationValidator.GetPosOrderByIdParam, { responseHeaders }?: object): Promise<OrderApplicationModel.OrderById>;
75
75
  /**
@@ -78,8 +78,8 @@ declare class Order {
78
78
  * @param {import("../ApplicationAPIClient").Options} - Options
79
79
  * @returns {Promise<OrderApplicationModel.ShipmentBagReasons>} - Success response
80
80
  * @name getShipmentBagReasons
81
- * @summary: Get reasons behind full or partial cancellation of a shipment
82
- * @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/application/order/getShipmentBagReasons/).
81
+ * @summary: Lists bag reasons.
82
+ * @description: Retrieves reasons that led to the cancellation for the status of shipment bags. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentBagReasons/).
83
83
  */
84
84
  getShipmentBagReasons({ shipmentId, bagId, requestHeaders }?: OrderApplicationValidator.GetShipmentBagReasonsParam, { responseHeaders }?: object): Promise<OrderApplicationModel.ShipmentBagReasons>;
85
85
  /**
@@ -88,8 +88,8 @@ declare class Order {
88
88
  * @param {import("../ApplicationAPIClient").Options} - Options
89
89
  * @returns {Promise<OrderApplicationModel.ShipmentById>} - Success response
90
90
  * @name getShipmentById
91
- * @summary: Get details of a shipment
92
- * @description: Use this API to retrieve shipment details such as price breakup, tracking details, store information, etc. using Shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentById/).
91
+ * @summary: Fetches shipment by ID.
92
+ * @description: Retrieve shipment details such as price breakup, tracking details, store information, etc. using Shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentById/).
93
93
  */
94
94
  getShipmentById({ shipmentId, allowInactive, requestHeaders }?: OrderApplicationValidator.GetShipmentByIdParam, { responseHeaders }?: object): Promise<OrderApplicationModel.ShipmentById>;
95
95
  /**
@@ -98,8 +98,8 @@ declare class Order {
98
98
  * @param {import("../ApplicationAPIClient").Options} - Options
99
99
  * @returns {Promise<OrderApplicationModel.ShipmentReasons>} - Success response
100
100
  * @name getShipmentReasons
101
- * @summary: Get reasons behind full or partial cancellation of a shipment
102
- * @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/application/order/getShipmentReasons/).
101
+ * @summary: Lists shipment reasons.
102
+ * @description: Retrieve reasons explaining various shipment statuses. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentReasons/).
103
103
  */
104
104
  getShipmentReasons({ shipmentId, requestHeaders }?: OrderApplicationValidator.GetShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderApplicationModel.ShipmentReasons>;
105
105
  /**
@@ -109,8 +109,8 @@ declare class Order {
109
109
  * @returns {Promise<OrderApplicationModel.SendOtpToCustomerResponse>} -
110
110
  * Success response
111
111
  * @name sendOtpToShipmentCustomer
112
- * @summary: Send and Resend Otp code to Order-Shipment customer
113
- * @description: Use this API to send OTP to the customer of the mapped Shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/sendOtpToShipmentCustomer/).
112
+ * @summary: Sends OTP to customer.
113
+ * @description: Sends a one-time password (OTP) to the customer for shipment verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/sendOtpToShipmentCustomer/).
114
114
  */
115
115
  sendOtpToShipmentCustomer({ orderId, shipmentId, requestHeaders }?: OrderApplicationValidator.SendOtpToShipmentCustomerParam, { responseHeaders }?: object): Promise<OrderApplicationModel.SendOtpToCustomerResponse>;
116
116
  /**
@@ -119,8 +119,8 @@ declare class Order {
119
119
  * @param {import("../ApplicationAPIClient").Options} - Options
120
120
  * @returns {Promise<OrderApplicationModel.ShipmentTrack>} - Success response
121
121
  * @name trackShipment
122
- * @summary: Track shipment
123
- * @description: Track Shipment by shipment id, for application based on application Id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/trackShipment/).
122
+ * @summary: Tracks shipment status.
123
+ * @description: Track Shipment by shipment id, for application based on application Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/trackShipment/).
124
124
  */
125
125
  trackShipment({ shipmentId, requestHeaders }?: OrderApplicationValidator.TrackShipmentParam, { responseHeaders }?: object): Promise<OrderApplicationModel.ShipmentTrack>;
126
126
  /**
@@ -131,8 +131,8 @@ declare class Order {
131
131
  * - Success response
132
132
  *
133
133
  * @name updateShipmentStatus
134
- * @summary: Update the shipment status
135
- * @description: Use this API to update the status of a shipment using its shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/updateShipmentStatus/).
134
+ * @summary: Updates shipment status.
135
+ * @description: Modifies the current status of a specific shipment using its shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/updateShipmentStatus/).
136
136
  */
137
137
  updateShipmentStatus({ shipmentId, body, requestHeaders }?: OrderApplicationValidator.UpdateShipmentStatusParam, { responseHeaders }?: object): Promise<OrderApplicationModel.ShipmentApplicationStatusResponse>;
138
138
  /**
@@ -141,8 +141,8 @@ declare class Order {
141
141
  * @param {import("../ApplicationAPIClient").Options} - Options
142
142
  * @returns {Promise<OrderApplicationModel.VerifyOtpResponse>} - Success response
143
143
  * @name verifyOtpShipmentCustomer
144
- * @summary: Verify Otp code
145
- * @description: Use this API to verify OTP and create a session token with custom payload. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/verifyOtpShipmentCustomer/).
144
+ * @summary: Verifies OTP.
145
+ * @description: Confirms the OTP sent to the shipment customer for verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/verifyOtpShipmentCustomer/).
146
146
  */
147
147
  verifyOtpShipmentCustomer({ orderId, shipmentId, body, requestHeaders }?: OrderApplicationValidator.VerifyOtpShipmentCustomerParam, { responseHeaders }?: object): Promise<OrderApplicationModel.VerifyOtpResponse>;
148
148
  }