@gofynd/fdk-client-javascript 1.4.8-beta.3 → 1.4.9

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 (189) hide show
  1. package/README.md +26 -1
  2. package/package.json +2 -2
  3. package/sdk/application/ApplicationClient.d.ts +8 -0
  4. package/sdk/application/ApplicationClient.js +14 -0
  5. package/sdk/application/Cart/CartApplicationClient.d.ts +20 -20
  6. package/sdk/application/Cart/CartApplicationClient.js +20 -20
  7. package/sdk/application/Cart/CartApplicationModel.d.ts +2446 -664
  8. package/sdk/application/Cart/CartApplicationModel.js +783 -552
  9. package/sdk/application/Cart/CartApplicationValidator.d.ts +268 -194
  10. package/sdk/application/Cart/CartApplicationValidator.js +100 -114
  11. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +53 -53
  12. package/sdk/application/Catalog/CatalogApplicationClient.js +53 -53
  13. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +2012 -503
  14. package/sdk/application/Catalog/CatalogApplicationModel.js +603 -453
  15. package/sdk/application/Catalog/CatalogApplicationValidator.d.ts +64 -64
  16. package/sdk/application/Catalog/CatalogApplicationValidator.js +32 -32
  17. package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
  18. package/sdk/application/Common/CommonApplicationClient.js +2 -2
  19. package/sdk/application/Common/CommonApplicationModel.d.ts +170 -90
  20. package/sdk/application/Common/CommonApplicationModel.js +59 -58
  21. package/sdk/application/Common/CommonApplicationValidator.d.ts +8 -5
  22. package/sdk/application/Common/CommonApplicationValidator.js +3 -3
  23. package/sdk/application/Communication/CommunicationApplicationClient.d.ts +2 -2
  24. package/sdk/application/Communication/CommunicationApplicationClient.js +2 -2
  25. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +170 -35
  26. package/sdk/application/Communication/CommunicationApplicationModel.js +54 -33
  27. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +15 -15
  28. package/sdk/application/Configuration/ConfigurationApplicationClient.js +15 -15
  29. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +624 -443
  30. package/sdk/application/Configuration/ConfigurationApplicationModel.js +259 -248
  31. package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +32 -24
  32. package/sdk/application/Configuration/ConfigurationApplicationValidator.js +14 -13
  33. package/sdk/application/Content/ContentApplicationClient.d.ts +16 -16
  34. package/sdk/application/Content/ContentApplicationClient.js +16 -16
  35. package/sdk/application/Content/ContentApplicationModel.d.ts +1205 -282
  36. package/sdk/application/Content/ContentApplicationModel.js +341 -277
  37. package/sdk/application/Content/ContentApplicationValidator.d.ts +28 -17
  38. package/sdk/application/Content/ContentApplicationValidator.js +11 -10
  39. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
  40. package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
  41. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +146 -37
  42. package/sdk/application/FileStorage/FileStorageApplicationModel.js +38 -36
  43. package/sdk/application/Lead/LeadApplicationClient.d.ts +3 -3
  44. package/sdk/application/Lead/LeadApplicationClient.js +3 -3
  45. package/sdk/application/Lead/LeadApplicationModel.d.ts +195 -134
  46. package/sdk/application/Lead/LeadApplicationModel.js +110 -67
  47. package/sdk/application/Lead/LeadApplicationValidator.d.ts +8 -8
  48. package/sdk/application/Lead/LeadApplicationValidator.js +4 -4
  49. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +10 -10
  50. package/sdk/application/Logistic/LogisticApplicationClient.js +10 -10
  51. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +1039 -221
  52. package/sdk/application/Logistic/LogisticApplicationModel.js +342 -199
  53. package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +76 -82
  54. package/sdk/application/Logistic/LogisticApplicationValidator.js +38 -41
  55. package/sdk/application/Order/OrderApplicationClient.d.ts +10 -10
  56. package/sdk/application/Order/OrderApplicationClient.js +10 -10
  57. package/sdk/application/Order/OrderApplicationModel.d.ts +1400 -325
  58. package/sdk/application/Order/OrderApplicationModel.js +391 -317
  59. package/sdk/application/Order/OrderApplicationValidator.d.ts +32 -30
  60. package/sdk/application/Order/OrderApplicationValidator.js +15 -14
  61. package/sdk/application/Payment/PaymentApplicationClient.d.ts +43 -43
  62. package/sdk/application/Payment/PaymentApplicationClient.js +43 -43
  63. package/sdk/application/Payment/PaymentApplicationModel.d.ts +1111 -1022
  64. package/sdk/application/Payment/PaymentApplicationModel.js +537 -521
  65. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +82 -49
  66. package/sdk/application/Payment/PaymentApplicationValidator.js +30 -30
  67. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +28 -7
  68. package/sdk/application/Rewards/RewardsApplicationModel.js +7 -7
  69. package/sdk/application/Share/ShareApplicationModel.d.ts +178 -38
  70. package/sdk/application/Share/ShareApplicationModel.js +53 -37
  71. package/sdk/application/Share/ShareApplicationValidator.d.ts +4 -2
  72. package/sdk/application/Share/ShareApplicationValidator.js +2 -1
  73. package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
  74. package/sdk/application/Theme/ThemeApplicationClient.js +14 -8
  75. package/sdk/application/Theme/ThemeApplicationModel.d.ts +528 -287
  76. package/sdk/application/Theme/ThemeApplicationModel.js +208 -172
  77. package/sdk/application/Theme/ThemeApplicationValidator.d.ts +17 -12
  78. package/sdk/application/Theme/ThemeApplicationValidator.js +8 -6
  79. package/sdk/application/User/UserApplicationClient.d.ts +36 -36
  80. package/sdk/application/User/UserApplicationClient.js +36 -36
  81. package/sdk/application/User/UserApplicationModel.d.ts +1062 -255
  82. package/sdk/application/User/UserApplicationModel.js +298 -244
  83. package/sdk/application/User/UserApplicationValidator.d.ts +80 -80
  84. package/sdk/application/User/UserApplicationValidator.js +40 -40
  85. package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
  86. package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
  87. package/sdk/application/Webhook/WebhookApplicationModel.d.ts +20 -5
  88. package/sdk/application/Webhook/WebhookApplicationModel.js +5 -5
  89. package/sdk/common/Clickstream.js +95 -15
  90. package/sdk/common/Constant.d.ts +9 -0
  91. package/sdk/common/Constant.js +11 -0
  92. package/sdk/common/Utility.js +19 -0
  93. package/sdk/common/utils.js +8 -1
  94. package/sdk/partner/Lead/LeadPartnerModel.d.ts +28 -7
  95. package/sdk/partner/Lead/LeadPartnerModel.js +7 -7
  96. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +28 -7
  97. package/sdk/partner/Logistics/LogisticsPartnerModel.js +7 -7
  98. package/sdk/partner/PartnerClient.d.ts +8 -0
  99. package/sdk/partner/PartnerClient.js +14 -0
  100. package/sdk/partner/Theme/ThemePartnerClient.d.ts +20 -0
  101. package/sdk/partner/Theme/ThemePartnerClient.js +158 -0
  102. package/sdk/partner/Theme/ThemePartnerModel.d.ts +45 -6
  103. package/sdk/partner/Theme/ThemePartnerModel.js +33 -4
  104. package/sdk/partner/Theme/ThemePartnerValidator.d.ts +2 -0
  105. package/sdk/partner/Theme/ThemePartnerValidator.js +14 -0
  106. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +28 -7
  107. package/sdk/partner/Webhook/WebhookPartnerModel.js +7 -7
  108. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +28 -7
  109. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +7 -7
  110. package/sdk/platform/Billing/BillingPlatformClient.d.ts +6 -397
  111. package/sdk/platform/Billing/BillingPlatformClient.js +77 -3215
  112. package/sdk/platform/Billing/BillingPlatformModel.d.ts +621 -2021
  113. package/sdk/platform/Billing/BillingPlatformModel.js +353 -2405
  114. package/sdk/platform/Billing/BillingPlatformValidator.d.ts +12 -451
  115. package/sdk/platform/Billing/BillingPlatformValidator.js +8 -483
  116. package/sdk/platform/Cart/CartPlatformModel.d.ts +28 -7
  117. package/sdk/platform/Cart/CartPlatformModel.js +8 -8
  118. package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +12 -2
  119. package/sdk/platform/Catalog/CatalogPlatformClient.js +41 -1
  120. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +46 -12
  121. package/sdk/platform/Catalog/CatalogPlatformModel.js +14 -11
  122. package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +40 -0
  123. package/sdk/platform/Catalog/CatalogPlatformValidator.js +17 -0
  124. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +28 -7
  125. package/sdk/platform/Communication/CommunicationPlatformModel.js +7 -7
  126. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +28 -7
  127. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +7 -7
  128. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +0 -97
  129. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +77 -782
  130. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +24 -701
  131. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +7 -539
  132. package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +1 -183
  133. package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +0 -134
  134. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +0 -10
  135. package/sdk/platform/Content/ContentPlatformApplicationClient.js +0 -79
  136. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -15
  137. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +0 -13
  138. package/sdk/platform/Content/ContentPlatformModel.d.ts +58 -17
  139. package/sdk/platform/Content/ContentPlatformModel.js +28 -15
  140. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +28 -7
  141. package/sdk/platform/Discount/DiscountPlatformModel.js +7 -7
  142. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +127 -25
  143. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +37 -25
  144. package/sdk/platform/Finance/FinancePlatformClient.d.ts +28 -28
  145. package/sdk/platform/Finance/FinancePlatformClient.js +28 -28
  146. package/sdk/platform/Finance/FinancePlatformModel.d.ts +1583 -347
  147. package/sdk/platform/Finance/FinancePlatformModel.js +463 -351
  148. package/sdk/platform/Lead/LeadPlatformModel.d.ts +28 -7
  149. package/sdk/platform/Lead/LeadPlatformModel.js +7 -7
  150. package/sdk/platform/Order/OrderPlatformClient.d.ts +22 -0
  151. package/sdk/platform/Order/OrderPlatformClient.js +165 -0
  152. package/sdk/platform/Order/OrderPlatformModel.d.ts +613 -39
  153. package/sdk/platform/Order/OrderPlatformModel.js +359 -41
  154. package/sdk/platform/Order/OrderPlatformValidator.d.ts +32 -1
  155. package/sdk/platform/Order/OrderPlatformValidator.js +28 -0
  156. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +30 -9
  157. package/sdk/platform/Payment/PaymentPlatformModel.js +9 -9
  158. package/sdk/platform/PlatformClient.d.ts +8 -0
  159. package/sdk/platform/PlatformClient.js +14 -0
  160. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +28 -7
  161. package/sdk/platform/Rewards/RewardsPlatformModel.js +7 -7
  162. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +12 -9
  163. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +12 -9
  164. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +120 -22
  165. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +76 -21
  166. package/sdk/platform/Share/SharePlatformModel.d.ts +28 -7
  167. package/sdk/platform/Share/SharePlatformModel.js +7 -7
  168. package/sdk/platform/Theme/ThemePlatformModel.d.ts +18 -5
  169. package/sdk/platform/Theme/ThemePlatformModel.js +7 -4
  170. package/sdk/platform/User/UserPlatformModel.d.ts +18 -18
  171. package/sdk/platform/User/UserPlatformModel.js +9 -9
  172. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +28 -7
  173. package/sdk/platform/Webhook/WebhookPlatformModel.js +7 -7
  174. package/sdk/public/PublicClient.d.ts +0 -4
  175. package/sdk/public/PublicClient.js +0 -8
  176. package/sdk/public/index.d.ts +0 -2
  177. package/sdk/public/index.js +0 -4
  178. package/sdk/public/Billing/BillingPublicClient.d.ts +0 -45
  179. package/sdk/public/Billing/BillingPublicClient.js +0 -269
  180. package/sdk/public/Billing/BillingPublicModel.d.ts +0 -434
  181. package/sdk/public/Billing/BillingPublicModel.js +0 -395
  182. package/sdk/public/Billing/BillingPublicValidator.d.ts +0 -34
  183. package/sdk/public/Billing/BillingPublicValidator.js +0 -38
  184. package/sdk/public/Inventory/InventoryPublicClient.d.ts +0 -87
  185. package/sdk/public/Inventory/InventoryPublicClient.js +0 -529
  186. package/sdk/public/Inventory/InventoryPublicModel.d.ts +0 -393
  187. package/sdk/public/Inventory/InventoryPublicModel.js +0 -448
  188. package/sdk/public/Inventory/InventoryPublicValidator.d.ts +0 -91
  189. package/sdk/public/Inventory/InventoryPublicValidator.js +0 -85
@@ -2,57 +2,53 @@ export = LogisticApplicationValidator;
2
2
  /** @typedef GetAllCountriesParam */
3
3
  /**
4
4
  * @typedef GetCountriesParam
5
- * @property {boolean} [onboarding] - Only fetch countries which allowed for
6
- * onboard on Platform.
7
- * @property {number} [pageNo] - Page number.
8
- * @property {number} [pageSize] - Page size.
9
- * @property {string} [q] - Search.
5
+ * @property {boolean} [onboarding] - List countries which allowed for onboard
6
+ * on Platform.
7
+ * @property {number} [pageNo] - The page number to navigate through the given
8
+ * set of results. Default value is 1.
9
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
10
+ * Default value is 12.
11
+ * @property {string} [q] - The number of items to retrieve in each page.
12
+ * Default value is 12.
10
13
  */
11
14
  /**
12
15
  * @typedef GetCountryParam
13
- * @property {string} countryIsoCode - The `country_iso_code` is ISO-2 (alpha-2)
14
- * code for the country.
16
+ * @property {string} countryIsoCode - The ISO 3166-1 alpha-2 code representing
17
+ * the country (e.g., "IN" for India, "US" for the United States).
15
18
  */
16
19
  /**
17
20
  * @typedef GetLocalitiesParam
18
- * @property {string} localityType - A `locality_type` contains unique
19
- * geographical division.
20
- * @property {string} [country] - A `country` contains a specific value of the
21
- * country iso2 code.
22
- * @property {string} [state] - A `state` contains a specific value of the
23
- * state, province.
24
- * @property {string} [city] - A `city` contains a specific value of the city.
25
- * @property {number} [pageNo] - Page number.
26
- * @property {number} [pageSize] - Page size.
27
- * @property {string} [q] - Search.
21
+ * @property {string} localityType - Unique geographical division.
22
+ * @property {string} [country] - Country name.
23
+ * @property {string} [state] - State or the province.
24
+ * @property {string} [city] - City.
25
+ * @property {number} [pageNo] - The page number to navigate through the given
26
+ * set of results. Default value is 1.
27
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
28
+ * Default value is 12.
29
+ * @property {string} [q] - This parameter is used to filter or search the records.
28
30
  */
29
31
  /**
30
32
  * @typedef GetLocalityParam
31
- * @property {string} localityType - A `locality_type` contains value
32
- * geographical division.
33
- * @property {string} localityValue - A `locality_value` contains a specific
34
- * name of the locality.
35
- * @property {string} [country] - A `country` contains a specific value of the
36
- * country iso2 code.
37
- * @property {string} [state] - A `state` contains a specific value of the
38
- * state, province.
39
- * @property {string} [city] - A `city` contains a specific value of the city.
33
+ * @property {string} localityType - Geographical division.
34
+ * @property {string} localityValue - Name of the locality.
35
+ * @property {string} [country] - Country name.
36
+ * @property {string} [state] - State or the province.
37
+ * @property {string} [city] - City.
40
38
  */
41
39
  /**
42
40
  * @typedef GetLocationsParam
43
- * @property {string} xApplicationId - A `x-application-id` is a unique
44
- * identifier for a particular sale channel.
45
- * @property {string} xApplicationData - A `x-application-data` is a unique
46
- * identifier for a particular sale channel.
47
- * @property {string} [country] - A `country` contains a specific value of the
48
- * country `iso2` code.
49
- * @property {string} [state] - A `state` contains a specific value of the
50
- * state, province.
51
- * @property {string} [city] - A `city` contains a specific value of the city.
52
- * @property {number} [pincode] - A `pincode` contains a specific value of the city.
53
- * @property {string} [sector] - A `sector` contains a specific value of the city.
54
- * @property {number} [pageNo] - Page number.
55
- * @property {number} [pageSize] - Page size.
41
+ * @property {string} xApplicationId - Unique identifier for a particular sales channel.
42
+ * @property {string} xApplicationData - Sales channel details.
43
+ * @property {string} [country] - The country `iso2` code.
44
+ * @property {string} [state] - State or the province.
45
+ * @property {string} [city] - City.
46
+ * @property {number} [pincode] - Pincode of the area.
47
+ * @property {string} [sector] - Specific sector of the city.
48
+ * @property {number} [pageNo] - The page number to navigate through the given
49
+ * set of results. Default value is 1.
50
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
51
+ * Default value is 12.
56
52
  */
57
53
  /**
58
54
  * @typedef GetOptimalLocationsParam
@@ -60,7 +56,7 @@ export = LogisticApplicationValidator;
60
56
  */
61
57
  /**
62
58
  * @typedef GetPincodeCityParam
63
- * @property {string} pincode - A `pincode` contains a specific address of a location.
59
+ * @property {string} pincode - Postal code or PIN code of the address area.
64
60
  */
65
61
  /**
66
62
  * @typedef GetPincodeZonesParam
@@ -72,7 +68,8 @@ export = LogisticApplicationValidator;
72
68
  */
73
69
  /**
74
70
  * @typedef ValidateAddressParam
75
- * @property {string} countryIsoCode - The ISO code of the country.
71
+ * @property {string} countryIsoCode - The ISO 3166-1 alpha-2 code representing
72
+ * the country (e.g., "IN" for India, "US" for the United States).
76
73
  * @property {string} templateName - The type of address form.
77
74
  * @property {LogisticApplicationModel.ValidateAddressRequest} body
78
75
  */
@@ -105,128 +102,124 @@ declare namespace LogisticApplicationValidator {
105
102
  }
106
103
  type GetCountriesParam = {
107
104
  /**
108
- * - Only fetch countries which allowed for
109
- * onboard on Platform.
105
+ * - List countries which allowed for onboard
106
+ * on Platform.
110
107
  */
111
108
  onboarding?: boolean;
112
109
  /**
113
- * - Page number.
110
+ * - The page number to navigate through the given
111
+ * set of results. Default value is 1.
114
112
  */
115
113
  pageNo?: number;
116
114
  /**
117
- * - Page size.
115
+ * - The number of items to retrieve in each page.
116
+ * Default value is 12.
118
117
  */
119
118
  pageSize?: number;
120
119
  /**
121
- * - Search.
120
+ * - The number of items to retrieve in each page.
121
+ * Default value is 12.
122
122
  */
123
123
  q?: string;
124
124
  };
125
125
  type GetCountryParam = {
126
126
  /**
127
- * - The `country_iso_code` is ISO-2 (alpha-2)
128
- * code for the country.
127
+ * - The ISO 3166-1 alpha-2 code representing
128
+ * the country (e.g., "IN" for India, "US" for the United States).
129
129
  */
130
130
  countryIsoCode: string;
131
131
  };
132
132
  type GetLocalitiesParam = {
133
133
  /**
134
- * - A `locality_type` contains unique
135
- * geographical division.
134
+ * - Unique geographical division.
136
135
  */
137
136
  localityType: string;
138
137
  /**
139
- * - A `country` contains a specific value of the
140
- * country iso2 code.
138
+ * - Country name.
141
139
  */
142
140
  country?: string;
143
141
  /**
144
- * - A `state` contains a specific value of the
145
- * state, province.
142
+ * - State or the province.
146
143
  */
147
144
  state?: string;
148
145
  /**
149
- * - A `city` contains a specific value of the city.
146
+ * - City.
150
147
  */
151
148
  city?: string;
152
149
  /**
153
- * - Page number.
150
+ * - The page number to navigate through the given
151
+ * set of results. Default value is 1.
154
152
  */
155
153
  pageNo?: number;
156
154
  /**
157
- * - Page size.
155
+ * - The number of items to retrieve in each page.
156
+ * Default value is 12.
158
157
  */
159
158
  pageSize?: number;
160
159
  /**
161
- * - Search.
160
+ * - This parameter is used to filter or search the records.
162
161
  */
163
162
  q?: string;
164
163
  };
165
164
  type GetLocalityParam = {
166
165
  /**
167
- * - A `locality_type` contains value
168
- * geographical division.
166
+ * - Geographical division.
169
167
  */
170
168
  localityType: string;
171
169
  /**
172
- * - A `locality_value` contains a specific
173
- * name of the locality.
170
+ * - Name of the locality.
174
171
  */
175
172
  localityValue: string;
176
173
  /**
177
- * - A `country` contains a specific value of the
178
- * country iso2 code.
174
+ * - Country name.
179
175
  */
180
176
  country?: string;
181
177
  /**
182
- * - A `state` contains a specific value of the
183
- * state, province.
178
+ * - State or the province.
184
179
  */
185
180
  state?: string;
186
181
  /**
187
- * - A `city` contains a specific value of the city.
182
+ * - City.
188
183
  */
189
184
  city?: string;
190
185
  };
191
186
  type GetLocationsParam = {
192
187
  /**
193
- * - A `x-application-id` is a unique
194
- * identifier for a particular sale channel.
188
+ * - Unique identifier for a particular sales channel.
195
189
  */
196
190
  xApplicationId: string;
197
191
  /**
198
- * - A `x-application-data` is a unique
199
- * identifier for a particular sale channel.
192
+ * - Sales channel details.
200
193
  */
201
194
  xApplicationData: string;
202
195
  /**
203
- * - A `country` contains a specific value of the
204
- * country `iso2` code.
196
+ * - The country `iso2` code.
205
197
  */
206
198
  country?: string;
207
199
  /**
208
- * - A `state` contains a specific value of the
209
- * state, province.
200
+ * - State or the province.
210
201
  */
211
202
  state?: string;
212
203
  /**
213
- * - A `city` contains a specific value of the city.
204
+ * - City.
214
205
  */
215
206
  city?: string;
216
207
  /**
217
- * - A `pincode` contains a specific value of the city.
208
+ * - Pincode of the area.
218
209
  */
219
210
  pincode?: number;
220
211
  /**
221
- * - A `sector` contains a specific value of the city.
212
+ * - Specific sector of the city.
222
213
  */
223
214
  sector?: string;
224
215
  /**
225
- * - Page number.
216
+ * - The page number to navigate through the given
217
+ * set of results. Default value is 1.
226
218
  */
227
219
  pageNo?: number;
228
220
  /**
229
- * - Page size.
221
+ * - The number of items to retrieve in each page.
222
+ * Default value is 12.
230
223
  */
231
224
  pageSize?: number;
232
225
  };
@@ -235,7 +228,7 @@ type GetOptimalLocationsParam = {
235
228
  };
236
229
  type GetPincodeCityParam = {
237
230
  /**
238
- * - A `pincode` contains a specific address of a location.
231
+ * - Postal code or PIN code of the address area.
239
232
  */
240
233
  pincode: string;
241
234
  };
@@ -247,7 +240,8 @@ type GetTatProductParam = {
247
240
  };
248
241
  type ValidateAddressParam = {
249
242
  /**
250
- * - The ISO code of the country.
243
+ * - The ISO 3166-1 alpha-2 code representing
244
+ * the country (e.g., "IN" for India, "US" for the United States).
251
245
  */
252
246
  countryIsoCode: string;
253
247
  /**
@@ -6,61 +6,57 @@ const LogisticApplicationModel = require("./LogisticApplicationModel");
6
6
 
7
7
  /**
8
8
  * @typedef GetCountriesParam
9
- * @property {boolean} [onboarding] - Only fetch countries which allowed for
10
- * onboard on Platform.
11
- * @property {number} [pageNo] - Page number.
12
- * @property {number} [pageSize] - Page size.
13
- * @property {string} [q] - Search.
9
+ * @property {boolean} [onboarding] - List countries which allowed for onboard
10
+ * on Platform.
11
+ * @property {number} [pageNo] - The page number to navigate through the given
12
+ * set of results. Default value is 1.
13
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
14
+ * Default value is 12.
15
+ * @property {string} [q] - The number of items to retrieve in each page.
16
+ * Default value is 12.
14
17
  */
15
18
 
16
19
  /**
17
20
  * @typedef GetCountryParam
18
- * @property {string} countryIsoCode - The `country_iso_code` is ISO-2 (alpha-2)
19
- * code for the country.
21
+ * @property {string} countryIsoCode - The ISO 3166-1 alpha-2 code representing
22
+ * the country (e.g., "IN" for India, "US" for the United States).
20
23
  */
21
24
 
22
25
  /**
23
26
  * @typedef GetLocalitiesParam
24
- * @property {string} localityType - A `locality_type` contains unique
25
- * geographical division.
26
- * @property {string} [country] - A `country` contains a specific value of the
27
- * country iso2 code.
28
- * @property {string} [state] - A `state` contains a specific value of the
29
- * state, province.
30
- * @property {string} [city] - A `city` contains a specific value of the city.
31
- * @property {number} [pageNo] - Page number.
32
- * @property {number} [pageSize] - Page size.
33
- * @property {string} [q] - Search.
27
+ * @property {string} localityType - Unique geographical division.
28
+ * @property {string} [country] - Country name.
29
+ * @property {string} [state] - State or the province.
30
+ * @property {string} [city] - City.
31
+ * @property {number} [pageNo] - The page number to navigate through the given
32
+ * set of results. Default value is 1.
33
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
34
+ * Default value is 12.
35
+ * @property {string} [q] - This parameter is used to filter or search the records.
34
36
  */
35
37
 
36
38
  /**
37
39
  * @typedef GetLocalityParam
38
- * @property {string} localityType - A `locality_type` contains value
39
- * geographical division.
40
- * @property {string} localityValue - A `locality_value` contains a specific
41
- * name of the locality.
42
- * @property {string} [country] - A `country` contains a specific value of the
43
- * country iso2 code.
44
- * @property {string} [state] - A `state` contains a specific value of the
45
- * state, province.
46
- * @property {string} [city] - A `city` contains a specific value of the city.
40
+ * @property {string} localityType - Geographical division.
41
+ * @property {string} localityValue - Name of the locality.
42
+ * @property {string} [country] - Country name.
43
+ * @property {string} [state] - State or the province.
44
+ * @property {string} [city] - City.
47
45
  */
48
46
 
49
47
  /**
50
48
  * @typedef GetLocationsParam
51
- * @property {string} xApplicationId - A `x-application-id` is a unique
52
- * identifier for a particular sale channel.
53
- * @property {string} xApplicationData - A `x-application-data` is a unique
54
- * identifier for a particular sale channel.
55
- * @property {string} [country] - A `country` contains a specific value of the
56
- * country `iso2` code.
57
- * @property {string} [state] - A `state` contains a specific value of the
58
- * state, province.
59
- * @property {string} [city] - A `city` contains a specific value of the city.
60
- * @property {number} [pincode] - A `pincode` contains a specific value of the city.
61
- * @property {string} [sector] - A `sector` contains a specific value of the city.
62
- * @property {number} [pageNo] - Page number.
63
- * @property {number} [pageSize] - Page size.
49
+ * @property {string} xApplicationId - Unique identifier for a particular sales channel.
50
+ * @property {string} xApplicationData - Sales channel details.
51
+ * @property {string} [country] - The country `iso2` code.
52
+ * @property {string} [state] - State or the province.
53
+ * @property {string} [city] - City.
54
+ * @property {number} [pincode] - Pincode of the area.
55
+ * @property {string} [sector] - Specific sector of the city.
56
+ * @property {number} [pageNo] - The page number to navigate through the given
57
+ * set of results. Default value is 1.
58
+ * @property {number} [pageSize] - The number of items to retrieve in each page.
59
+ * Default value is 12.
64
60
  */
65
61
 
66
62
  /**
@@ -70,7 +66,7 @@ const LogisticApplicationModel = require("./LogisticApplicationModel");
70
66
 
71
67
  /**
72
68
  * @typedef GetPincodeCityParam
73
- * @property {string} pincode - A `pincode` contains a specific address of a location.
69
+ * @property {string} pincode - Postal code or PIN code of the address area.
74
70
  */
75
71
 
76
72
  /**
@@ -85,7 +81,8 @@ const LogisticApplicationModel = require("./LogisticApplicationModel");
85
81
 
86
82
  /**
87
83
  * @typedef ValidateAddressParam
88
- * @property {string} countryIsoCode - The ISO code of the country.
84
+ * @property {string} countryIsoCode - The ISO 3166-1 alpha-2 code representing
85
+ * the country (e.g., "IN" for India, "US" for the United States).
89
86
  * @property {string} templateName - The type of address form.
90
87
  * @property {LogisticApplicationModel.ValidateAddressRequest} body
91
88
  */
@@ -27,7 +27,7 @@ declare class Order {
27
27
  * Success response
28
28
  * @name getCustomerDetailsByShipmentId
29
29
  * @summary: Get shipment's customer
30
- * @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/).
30
+ * @description: Get customer details such as mobile number using Shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getCustomerDetailsByShipmentId/).
31
31
  */
32
32
  getCustomerDetailsByShipmentId({ orderId, shipmentId, requestHeaders }?: OrderApplicationValidator.GetCustomerDetailsByShipmentIdParam, { responseHeaders }?: object): Promise<OrderApplicationModel.CustomerDetailsResponse>;
33
33
  /**
@@ -38,7 +38,7 @@ declare class Order {
38
38
  * Success response
39
39
  * @name getInvoiceByShipmentId
40
40
  * @summary: Retrieves invoice for shipment
41
- * @description: Retrieve the invoice corresponding to a specific shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getInvoiceByShipmentId/).
41
+ * @description: Get invoice corresponding to a specific shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getInvoiceByShipmentId/).
42
42
  */
43
43
  getInvoiceByShipmentId({ shipmentId, requestHeaders }?: OrderApplicationValidator.GetInvoiceByShipmentIdParam, { responseHeaders }?: object): Promise<OrderApplicationModel.ResponseGetInvoiceShipment>;
44
44
  /**
@@ -48,7 +48,7 @@ declare class Order {
48
48
  * @returns {Promise<OrderApplicationModel.OrderById>} - Success response
49
49
  * @name getOrderById
50
50
  * @summary: Get an order
51
- * @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/).
51
+ * @description: Get 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/).
52
52
  */
53
53
  getOrderById({ orderId, allowInactive, requestHeaders }?: OrderApplicationValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderApplicationModel.OrderById>;
54
54
  /**
@@ -58,7 +58,7 @@ declare class Order {
58
58
  * @returns {Promise<OrderApplicationModel.OrderList>} - Success response
59
59
  * @name getOrders
60
60
  * @summary: List customer orders
61
- * @description: Retrieves all orders associated with a customer account - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getOrders/).
61
+ * @description: Get all orders associated with a customer account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getOrders/).
62
62
  */
63
63
  getOrders({ status, pageNo, pageSize, fromDate, toDate, startDate, endDate, customMeta, allowInactive, requestHeaders, }?: OrderApplicationValidator.GetOrdersParam, { responseHeaders }?: object): Promise<OrderApplicationModel.OrderList>;
64
64
  /**
@@ -68,7 +68,7 @@ declare class Order {
68
68
  * @returns {Promise<OrderApplicationModel.ShipmentBagReasons>} - Success response
69
69
  * @name getShipmentBagReasons
70
70
  * @summary: List bag cancellation reasons
71
- * @description: Get reasons to perform full or partial cancellation of a bag - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentBagReasons/).
71
+ * @description: Get reasons to perform full or partial cancellation of a bag. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentBagReasons/).
72
72
  */
73
73
  getShipmentBagReasons({ shipmentId, bagId, requestHeaders }?: OrderApplicationValidator.GetShipmentBagReasonsParam, { responseHeaders }?: object): Promise<OrderApplicationModel.ShipmentBagReasons>;
74
74
  /**
@@ -78,7 +78,7 @@ declare class Order {
78
78
  * @returns {Promise<OrderApplicationModel.ShipmentById>} - Success response
79
79
  * @name getShipmentById
80
80
  * @summary: Get a Shipment
81
- * @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/).
81
+ * @description: Get 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/).
82
82
  */
83
83
  getShipmentById({ shipmentId, allowInactive, requestHeaders }?: OrderApplicationValidator.GetShipmentByIdParam, { responseHeaders }?: object): Promise<OrderApplicationModel.ShipmentById>;
84
84
  /**
@@ -88,7 +88,7 @@ declare class Order {
88
88
  * @returns {Promise<OrderApplicationModel.ShipmentReasons>} - Success response
89
89
  * @name getShipmentReasons
90
90
  * @summary: List shipment cancellation reasons
91
- * @description: Get reasons to perform full or partial cancellation of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentReasons/).
91
+ * @description: Get reasons to perform full or partial cancellation of a shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentReasons/).
92
92
  */
93
93
  getShipmentReasons({ shipmentId, requestHeaders }?: OrderApplicationValidator.GetShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderApplicationModel.ShipmentReasons>;
94
94
  /**
@@ -99,7 +99,7 @@ declare class Order {
99
99
  * Success response
100
100
  * @name sendOtpToShipmentCustomer
101
101
  * @summary: Send OTP to customer
102
- * @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/).
102
+ * @description: Send OTP to the customer for shipment verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/sendOtpToShipmentCustomer/).
103
103
  */
104
104
  sendOtpToShipmentCustomer({ orderId, shipmentId, requestHeaders }?: OrderApplicationValidator.SendOtpToShipmentCustomerParam, { responseHeaders }?: object): Promise<OrderApplicationModel.SendOtpToCustomerResponse>;
105
105
  /**
@@ -121,7 +121,7 @@ declare class Order {
121
121
  *
122
122
  * @name updateShipmentStatus
123
123
  * @summary: Updates shipment status
124
- * @description: Modifies the current status of a specific shipment using its shipment ID. Supports both partial and full transition as per the configured settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/updateShipmentStatus/).
124
+ * @description: Update current status of a specific shipment using its shipment ID. Supports both partial and full transition as per the configured settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/updateShipmentStatus/).
125
125
  */
126
126
  updateShipmentStatus({ shipmentId, body, requestHeaders }?: OrderApplicationValidator.UpdateShipmentStatusParam, { responseHeaders }?: object): Promise<OrderApplicationModel.ShipmentApplicationStatusResponse>;
127
127
  /**
@@ -131,7 +131,7 @@ declare class Order {
131
131
  * @returns {Promise<OrderApplicationModel.VerifyOtpResponse>} - Success response
132
132
  * @name verifyOtpShipmentCustomer
133
133
  * @summary: Verifies OTP
134
- * @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/).
134
+ * @description: Verify OTP sent by customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/verifyOtpShipmentCustomer/).
135
135
  */
136
136
  verifyOtpShipmentCustomer({ orderId, shipmentId, body, requestHeaders }?: OrderApplicationValidator.VerifyOtpShipmentCustomerParam, { responseHeaders }?: object): Promise<OrderApplicationModel.VerifyOtpResponse>;
137
137
  }
@@ -61,7 +61,7 @@ class Order {
61
61
  * Success response
62
62
  * @name getCustomerDetailsByShipmentId
63
63
  * @summary: Get shipment's customer
64
- * @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/).
64
+ * @description: Get customer details such as mobile number using Shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getCustomerDetailsByShipmentId/).
65
65
  */
66
66
  async getCustomerDetailsByShipmentId(
67
67
  { orderId, shipmentId, requestHeaders } = { requestHeaders: {} },
@@ -142,7 +142,7 @@ class Order {
142
142
  * Success response
143
143
  * @name getInvoiceByShipmentId
144
144
  * @summary: Retrieves invoice for shipment
145
- * @description: Retrieve the invoice corresponding to a specific shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getInvoiceByShipmentId/).
145
+ * @description: Get invoice corresponding to a specific shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getInvoiceByShipmentId/).
146
146
  */
147
147
  async getInvoiceByShipmentId(
148
148
  { shipmentId, requestHeaders } = { requestHeaders: {} },
@@ -222,7 +222,7 @@ class Order {
222
222
  * @returns {Promise<OrderApplicationModel.OrderById>} - Success response
223
223
  * @name getOrderById
224
224
  * @summary: Get an order
225
- * @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/).
225
+ * @description: Get 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/).
226
226
  */
227
227
  async getOrderById(
228
228
  { orderId, allowInactive, requestHeaders } = { requestHeaders: {} },
@@ -301,7 +301,7 @@ class Order {
301
301
  * @returns {Promise<OrderApplicationModel.OrderList>} - Success response
302
302
  * @name getOrders
303
303
  * @summary: List customer orders
304
- * @description: Retrieves all orders associated with a customer account - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getOrders/).
304
+ * @description: Get all orders associated with a customer account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getOrders/).
305
305
  */
306
306
  async getOrders(
307
307
  {
@@ -417,7 +417,7 @@ class Order {
417
417
  * @returns {Promise<OrderApplicationModel.ShipmentBagReasons>} - Success response
418
418
  * @name getShipmentBagReasons
419
419
  * @summary: List bag cancellation reasons
420
- * @description: Get reasons to perform full or partial cancellation of a bag - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentBagReasons/).
420
+ * @description: Get reasons to perform full or partial cancellation of a bag. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentBagReasons/).
421
421
  */
422
422
  async getShipmentBagReasons(
423
423
  { shipmentId, bagId, requestHeaders } = { requestHeaders: {} },
@@ -497,7 +497,7 @@ class Order {
497
497
  * @returns {Promise<OrderApplicationModel.ShipmentById>} - Success response
498
498
  * @name getShipmentById
499
499
  * @summary: Get a Shipment
500
- * @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/).
500
+ * @description: Get 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/).
501
501
  */
502
502
  async getShipmentById(
503
503
  { shipmentId, allowInactive, requestHeaders } = { requestHeaders: {} },
@@ -576,7 +576,7 @@ class Order {
576
576
  * @returns {Promise<OrderApplicationModel.ShipmentReasons>} - Success response
577
577
  * @name getShipmentReasons
578
578
  * @summary: List shipment cancellation reasons
579
- * @description: Get reasons to perform full or partial cancellation of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentReasons/).
579
+ * @description: Get reasons to perform full or partial cancellation of a shipment. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentReasons/).
580
580
  */
581
581
  async getShipmentReasons(
582
582
  { shipmentId, requestHeaders } = { requestHeaders: {} },
@@ -655,7 +655,7 @@ class Order {
655
655
  * Success response
656
656
  * @name sendOtpToShipmentCustomer
657
657
  * @summary: Send OTP to customer
658
- * @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/).
658
+ * @description: Send OTP to the customer for shipment verification. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/sendOtpToShipmentCustomer/).
659
659
  */
660
660
  async sendOtpToShipmentCustomer(
661
661
  { orderId, shipmentId, requestHeaders } = { requestHeaders: {} },
@@ -815,7 +815,7 @@ class Order {
815
815
  *
816
816
  * @name updateShipmentStatus
817
817
  * @summary: Updates shipment status
818
- * @description: Modifies the current status of a specific shipment using its shipment ID. Supports both partial and full transition as per the configured settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/updateShipmentStatus/).
818
+ * @description: Update current status of a specific shipment using its shipment ID. Supports both partial and full transition as per the configured settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/updateShipmentStatus/).
819
819
  */
820
820
  async updateShipmentStatus(
821
821
  { shipmentId, body, requestHeaders } = { requestHeaders: {} },
@@ -893,7 +893,7 @@ class Order {
893
893
  * @returns {Promise<OrderApplicationModel.VerifyOtpResponse>} - Success response
894
894
  * @name verifyOtpShipmentCustomer
895
895
  * @summary: Verifies OTP
896
- * @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/).
896
+ * @description: Verify OTP sent by customer. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/verifyOtpShipmentCustomer/).
897
897
  */
898
898
  async verifyOtpShipmentCustomer(
899
899
  { orderId, shipmentId, body, requestHeaders } = { requestHeaders: {} },