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

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 (106) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationModel.d.ts +1742 -1726
  4. package/sdk/application/Cart/CartApplicationModel.js +1497 -1481
  5. package/sdk/application/Catalog/CatalogApplicationModel.d.ts +1917 -1917
  6. package/sdk/application/Catalog/CatalogApplicationModel.js +1611 -1611
  7. package/sdk/application/Common/CommonApplicationModel.d.ts +235 -235
  8. package/sdk/application/Common/CommonApplicationModel.js +172 -172
  9. package/sdk/application/Communication/CommunicationApplicationModel.d.ts +72 -72
  10. package/sdk/application/Communication/CommunicationApplicationModel.js +64 -64
  11. package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1614 -1614
  12. package/sdk/application/Configuration/ConfigurationApplicationModel.js +1151 -1151
  13. package/sdk/application/Content/ContentApplicationModel.d.ts +797 -797
  14. package/sdk/application/Content/ContentApplicationModel.js +757 -757
  15. package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +79 -79
  16. package/sdk/application/FileStorage/FileStorageApplicationModel.js +84 -84
  17. package/sdk/application/Lead/LeadApplicationModel.d.ts +417 -417
  18. package/sdk/application/Lead/LeadApplicationModel.js +301 -301
  19. package/sdk/application/Logistic/LogisticApplicationModel.d.ts +666 -666
  20. package/sdk/application/Logistic/LogisticApplicationModel.js +601 -601
  21. package/sdk/application/Order/OrderApplicationModel.d.ts +846 -846
  22. package/sdk/application/Order/OrderApplicationModel.js +822 -822
  23. package/sdk/application/Payment/PaymentApplicationClient.d.ts +5 -5
  24. package/sdk/application/Payment/PaymentApplicationClient.js +10 -10
  25. package/sdk/application/Payment/PaymentApplicationModel.d.ts +2155 -2150
  26. package/sdk/application/Payment/PaymentApplicationModel.js +1460 -1458
  27. package/sdk/application/Payment/PaymentApplicationValidator.d.ts +5 -5
  28. package/sdk/application/Payment/PaymentApplicationValidator.js +3 -3
  29. package/sdk/application/PosCart/PosCartApplicationModel.d.ts +1462 -1462
  30. package/sdk/application/PosCart/PosCartApplicationModel.js +1260 -1260
  31. package/sdk/application/Rewards/RewardsApplicationModel.d.ts +214 -214
  32. package/sdk/application/Rewards/RewardsApplicationModel.js +211 -211
  33. package/sdk/application/Share/ShareApplicationModel.d.ts +114 -114
  34. package/sdk/application/Share/ShareApplicationModel.js +121 -121
  35. package/sdk/application/Theme/ThemeApplicationModel.d.ts +895 -895
  36. package/sdk/application/Theme/ThemeApplicationModel.js +684 -684
  37. package/sdk/application/User/UserApplicationModel.d.ts +762 -762
  38. package/sdk/application/User/UserApplicationModel.js +738 -738
  39. package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +63 -63
  40. package/sdk/partner/FileStorage/FileStoragePartnerModel.js +65 -65
  41. package/sdk/partner/Lead/LeadPartnerModel.d.ts +661 -661
  42. package/sdk/partner/Lead/LeadPartnerModel.js +491 -491
  43. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +223 -223
  44. package/sdk/partner/Logistics/LogisticsPartnerModel.js +235 -235
  45. package/sdk/partner/Theme/ThemePartnerModel.d.ts +1087 -1087
  46. package/sdk/partner/Theme/ThemePartnerModel.js +819 -819
  47. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +386 -386
  48. package/sdk/partner/Webhook/WebhookPartnerModel.js +342 -342
  49. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +123 -123
  50. package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +109 -109
  51. package/sdk/platform/Billing/BillingPlatformModel.d.ts +801 -801
  52. package/sdk/platform/Billing/BillingPlatformModel.js +783 -783
  53. package/sdk/platform/Cart/CartPlatformModel.d.ts +3333 -3317
  54. package/sdk/platform/Cart/CartPlatformModel.js +2936 -2920
  55. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1013 -1013
  56. package/sdk/platform/Catalog/CatalogPlatformModel.js +923 -923
  57. package/sdk/platform/Common/CommonPlatformModel.d.ts +255 -255
  58. package/sdk/platform/Common/CommonPlatformModel.js +187 -187
  59. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +1238 -1238
  60. package/sdk/platform/Communication/CommunicationPlatformModel.js +1273 -1273
  61. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +661 -661
  62. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +692 -692
  63. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +3198 -3198
  64. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +2247 -2247
  65. package/sdk/platform/Content/ContentPlatformModel.d.ts +1833 -1833
  66. package/sdk/platform/Content/ContentPlatformModel.js +1837 -1837
  67. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +245 -245
  68. package/sdk/platform/Discount/DiscountPlatformModel.js +248 -248
  69. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +865 -865
  70. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +877 -877
  71. package/sdk/platform/Finance/FinancePlatformModel.d.ts +1044 -1044
  72. package/sdk/platform/Finance/FinancePlatformModel.js +974 -974
  73. package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +942 -942
  74. package/sdk/platform/Inventory/InventoryPlatformModel.js +1003 -1003
  75. package/sdk/platform/Lead/LeadPlatformModel.d.ts +608 -608
  76. package/sdk/platform/Lead/LeadPlatformModel.js +465 -465
  77. package/sdk/platform/Order/OrderPlatformModel.d.ts +5180 -5176
  78. package/sdk/platform/Order/OrderPlatformModel.js +4740 -4736
  79. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +22 -22
  80. package/sdk/platform/Partner/PartnerPlatformModel.js +22 -22
  81. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2670 -2660
  82. package/sdk/platform/Payment/PaymentPlatformModel.js +1831 -1827
  83. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +204 -204
  84. package/sdk/platform/Rewards/RewardsPlatformModel.js +199 -199
  85. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1505 -1507
  86. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +1532 -1536
  87. package/sdk/platform/Share/SharePlatformModel.d.ts +147 -147
  88. package/sdk/platform/Share/SharePlatformModel.js +139 -139
  89. package/sdk/platform/Theme/ThemePlatformModel.d.ts +1046 -1046
  90. package/sdk/platform/Theme/ThemePlatformModel.js +789 -789
  91. package/sdk/platform/User/UserPlatformModel.d.ts +758 -758
  92. package/sdk/platform/User/UserPlatformModel.js +643 -643
  93. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +439 -439
  94. package/sdk/platform/Webhook/WebhookPlatformModel.js +364 -364
  95. package/sdk/public/Billing/BillingPublicModel.d.ts +55 -55
  96. package/sdk/public/Billing/BillingPublicModel.js +51 -51
  97. package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +237 -237
  98. package/sdk/public/Configuration/ConfigurationPublicModel.js +174 -174
  99. package/sdk/public/Content/ContentPublicModel.d.ts +26 -26
  100. package/sdk/public/Content/ContentPublicModel.js +28 -28
  101. package/sdk/public/Inventory/InventoryPublicModel.d.ts +237 -237
  102. package/sdk/public/Inventory/InventoryPublicModel.js +257 -257
  103. package/sdk/public/Partner/PartnerPublicModel.d.ts +104 -104
  104. package/sdk/public/Partner/PartnerPublicModel.js +113 -113
  105. package/sdk/public/Webhook/WebhookPublicModel.d.ts +87 -87
  106. package/sdk/public/Webhook/WebhookPublicModel.js +93 -93
@@ -1,24 +1,62 @@
1
1
  export = LogisticApplicationModel;
2
2
  /**
3
- * @typedef CountryEntityResponse
3
+ * @typedef GetStoreResponse
4
+ * @property {StoreItemResponse[]} [items]
5
+ * @property {Page} [page]
6
+ */
7
+ /**
8
+ * @typedef StoreItemResponse
9
+ * @property {number} [id]
10
+ * @property {string} [store_type]
11
+ * @property {string} [fulfillment_type]
12
+ * @property {number} [processing_time]
13
+ * @property {string[]} [tags]
14
+ * @property {number} [company_id]
15
+ * @property {number} [latitude]
16
+ * @property {number} [longitude]
17
+ */
18
+ /**
19
+ * @typedef ValidateAddressRequest
20
+ * @property {string} [address] - A string representing the complete address,
21
+ * combining address line 1, address line 2, area, landmark, sector, city,
22
+ * state, and pincode. This provides a comprehensive view of the address details.
23
+ * @property {string} [address1] - A string representing the first line of the
24
+ * address, typically containing street or building information.
25
+ * @property {string} [address2] - A string representing the second line of the
26
+ * address, which can be used for additional address details if needed.
27
+ * @property {string} [area] - A string specifying the locality or area
28
+ * associated with the address.
29
+ * @property {string} [landmark] - A string representing a prominent nearby
30
+ * landmark that aids in locating the address.
31
+ * @property {string} [pincode] - A string indicating the postal code or PIN
32
+ * code of the address area.
33
+ * @property {string} [sector] - A string specifying the sector or district of
34
+ * the address if applicable.
35
+ * @property {string} [city] - A string denoting the city or municipality of the address.
36
+ * @property {string} [state] - A string indicating the state or province of the address.
37
+ * @property {string} [name] - A string representing the recipient's name or the
38
+ * organization name associated with the address.
39
+ * @property {string} [phone] - An integer representing the recipient's contact
40
+ * phone number.
41
+ * @property {string} [email] - A string containing the recipient's email address.
42
+ */
43
+ /**
44
+ * @typedef PincodeParentsResponse
45
+ * @property {string} [sub_type]
4
46
  * @property {string} [display_name]
5
- * @property {boolean} [is_active]
6
- * @property {LogisticsResponse} [logistics]
7
- * @property {CountryMetaResponse} [meta]
8
47
  * @property {string} [name]
9
- * @property {string} [parent_id]
10
- * @property {string} [sub_type]
11
- * @property {string} [type]
12
48
  * @property {string} [uid]
13
49
  */
14
50
  /**
15
- * @typedef CountryHierarchy
16
- * @property {string} [name]
17
- * @property {string} [slug]
51
+ * @typedef PincodeMetaResponse
52
+ * @property {string} [zone]
53
+ * @property {number} [internal_zone_id]
18
54
  */
19
55
  /**
20
- * @typedef CountryListResponse
21
- * @property {CountryEntityResponse[]} [results]
56
+ * @typedef PincodeErrorSchemaResponse
57
+ * @property {string} [message]
58
+ * @property {string} [value]
59
+ * @property {string} [type]
22
60
  */
23
61
  /**
24
62
  * @typedef CountryMetaResponse
@@ -26,147 +64,144 @@ export = LogisticApplicationModel;
26
64
  * @property {string} [isd_code]
27
65
  */
28
66
  /**
29
- * @typedef CountryObject
30
- * @property {CurrencyObject} [currency]
31
- * @property {string} [display_name]
32
- * @property {CountryHierarchy[]} [hierarchy]
33
- * @property {string} [id]
34
- * @property {string} [iso2]
35
- * @property {string} [iso3]
36
- * @property {string} [latitude]
37
- * @property {string} [longitude]
38
- * @property {string} [name]
39
- * @property {string} [phone_code]
40
- * @property {string[]} [timezones]
67
+ * @typedef PincodeLatLongData
41
68
  * @property {string} [type]
69
+ * @property {string[]} [coordinates]
42
70
  */
43
71
  /**
44
- * @typedef CurrencyObject
45
- * @property {string} [code]
72
+ * @typedef PincodeDataResponse
73
+ * @property {PincodeParentsResponse[]} [parents]
74
+ * @property {PincodeMetaResponse} [meta]
75
+ * @property {string} [display_name]
76
+ * @property {PincodeErrorSchemaResponse} error
77
+ * @property {CountryMetaResponse} [meta_code]
78
+ * @property {PincodeLatLongData} [lat_long]
79
+ * @property {string} [sub_type]
46
80
  * @property {string} [name]
47
- * @property {string} [symbol]
81
+ * @property {string} [uid]
48
82
  */
49
83
  /**
50
- * @typedef DP
51
- * @property {string} [area_code]
52
- * @property {boolean} [assign_dp_from_sb]
53
- * @property {string} [external_account_id]
54
- * @property {number} fm_priority
55
- * @property {string} [internal_account_id]
56
- * @property {number} lm_priority
57
- * @property {string[]} operations
58
- * @property {string} payment_mode
59
- * @property {number} rvp_priority
60
- * @property {string} [transport_mode]
84
+ * @typedef PincodeApiResponse
85
+ * @property {boolean} success
86
+ * @property {PincodeDataResponse[]} [data]
87
+ * @property {PincodeErrorSchemaResponse} error
61
88
  */
62
89
  /**
63
- * @typedef ErrorResponse
64
- * @property {string} [error]
90
+ * @typedef TATCategoryRequest
91
+ * @property {string} [level]
92
+ * @property {number} [id]
65
93
  */
66
94
  /**
67
- * @typedef FieldValidation
68
- * @property {FieldValidationRegex} [regex]
69
- * @property {string} [type]
95
+ * @typedef TATArticlesRequest
96
+ * @property {TATCategoryRequest} [category]
97
+ * @property {string} [manufacturing_time_unit]
98
+ * @property {number} [manufacturing_time]
70
99
  */
71
100
  /**
72
- * @typedef FieldValidationRegex
73
- * @property {LengthValidation} [length]
74
- * @property {string} [value]
101
+ * @typedef TATLocationDetailsRequest
102
+ * @property {number} [fulfillment_id]
103
+ * @property {string} [from_pincode]
104
+ * @property {TATArticlesRequest[]} [articles]
75
105
  */
76
106
  /**
77
- * @typedef GetCountries
78
- * @property {CountryObject[]} [items]
79
- * @property {Page} [page]
107
+ * @typedef TATViewRequest
108
+ * @property {string} [to_pincode]
109
+ * @property {string} [source]
110
+ * @property {string} [action]
111
+ * @property {string} [identifier]
112
+ * @property {TATLocationDetailsRequest[]} [location_details]
113
+ * @property {string} [journey]
80
114
  */
81
115
  /**
82
- * @typedef GetCountry
83
- * @property {CurrencyObject} [currency]
84
- * @property {string} [display_name]
85
- * @property {GetCountryFields} [fields]
86
- * @property {CountryHierarchy[]} [hierarchy]
87
- * @property {string} [id]
88
- * @property {string} [iso2]
89
- * @property {string} [iso3]
90
- * @property {string} [latitude]
91
- * @property {string} [longitude]
92
- * @property {string} [name]
93
- * @property {string} [phone_code]
94
- * @property {string[]} [timezones]
116
+ * @typedef TATErrorSchemaResponse
117
+ * @property {string} [message]
118
+ * @property {string} [value]
95
119
  * @property {string} [type]
96
120
  */
97
121
  /**
98
- * @typedef GetCountryFields
99
- * @property {GetCountryFieldsAddress[]} address
100
- * @property {GetCountryFieldsAddressTemplate} address_template
101
- * @property {string[]} serviceability_fields
122
+ * @typedef TATTimestampResponse
123
+ * @property {number} [min]
124
+ * @property {number} [max]
102
125
  */
103
126
  /**
104
- * @typedef GetCountryFieldsAddress
105
- * @property {string} display_name
106
- * @property {boolean} [edit]
107
- * @property {string} [error_text]
108
- * @property {string} input
109
- * @property {boolean} required
110
- * @property {string} slug
111
- * @property {FieldValidation} [validation]
112
- * @property {GetCountryFieldsAddressValues} [values]
127
+ * @typedef TATFormattedResponse
128
+ * @property {string} [min]
129
+ * @property {string} [max]
113
130
  */
114
131
  /**
115
- * @typedef GetCountryFieldsAddressTemplate
116
- * @property {string} checkout_form
117
- * @property {string} default_display
118
- * @property {string} store_os_form
132
+ * @typedef TATPromiseResponse
133
+ * @property {TATTimestampResponse} [timestamp]
134
+ * @property {TATFormattedResponse} [formatted]
119
135
  */
120
136
  /**
121
- * @typedef GetCountryFieldsAddressValues
122
- * @property {GetOneOrAll} [get_all]
123
- * @property {GetOneOrAll} [get_one]
137
+ * @typedef TATArticlesResponse
138
+ * @property {string} [manufacturing_time_unit]
139
+ * @property {TATErrorSchemaResponse} [error]
140
+ * @property {boolean} [is_cod_available]
141
+ * @property {TATPromiseResponse} [promise]
142
+ * @property {number} [manufacturing_time]
143
+ * @property {TATCategoryRequest} [category]
144
+ * @property {number} [_manufacturing_time_seconds]
124
145
  */
125
146
  /**
126
- * @typedef GetLocalities
127
- * @property {Localities[]} [items]
128
- * @property {Page} [page]
147
+ * @typedef TATLocationDetailsResponse
148
+ * @property {number} [fulfillment_id]
149
+ * @property {string} [from_pincode]
150
+ * @property {TATArticlesResponse[]} [articles]
129
151
  */
130
152
  /**
131
- * @typedef GetLocality
132
- * @property {string} [display_name]
133
- * @property {string} [id]
134
- * @property {LocalityParent[]} [localities]
135
- * @property {string} [name]
136
- * @property {string[]} [parent_ids]
137
- * @property {string} [type]
153
+ * @typedef TATViewResponse
154
+ * @property {string} [to_pincode]
155
+ * @property {string} [request_uuid]
156
+ * @property {string} [payment_mode]
157
+ * @property {boolean} [success]
158
+ * @property {TATErrorSchemaResponse} [error]
159
+ * @property {boolean} [is_cod_available]
160
+ * @property {string} [source]
161
+ * @property {string} [action]
162
+ * @property {string} [stormbreaker_uuid]
163
+ * @property {string} [to_city]
164
+ * @property {string} [identifier]
165
+ * @property {TATLocationDetailsResponse[]} [location_details]
166
+ * @property {string} [journey]
138
167
  */
139
168
  /**
140
- * @typedef GetOneOrAll
141
- * @property {string} [operation_id]
142
- * @property {GetOneOrAllParams} [params]
169
+ * @typedef DP
170
+ * @property {number} fm_priority
171
+ * @property {number} lm_priority
172
+ * @property {number} rvp_priority
173
+ * @property {string} payment_mode
174
+ * @property {string[]} operations
175
+ * @property {string} [area_code]
176
+ * @property {boolean} [assign_dp_from_sb]
177
+ * @property {string} [internal_account_id]
178
+ * @property {string} [external_account_id]
179
+ * @property {string} [transport_mode]
143
180
  */
144
181
  /**
145
- * @typedef GetOneOrAllParams
146
- * @property {GetOneOrAllPath} [path]
147
- * @property {GetOneOrAllQuery} [query]
182
+ * @typedef LogisticsResponse
183
+ * @property {Object} [dp]
148
184
  */
149
185
  /**
150
- * @typedef GetOneOrAllPath
151
- * @property {string} [locality_type]
152
- * @property {string} [locality_value]
186
+ * @typedef CountryEntityResponse
187
+ * @property {CountryMetaResponse} [meta]
188
+ * @property {LogisticsResponse} [logistics]
189
+ * @property {string} [display_name]
190
+ * @property {string} [type]
191
+ * @property {boolean} [is_active]
192
+ * @property {string} [parent_id]
193
+ * @property {string} [sub_type]
194
+ * @property {string} [name]
195
+ * @property {string} [uid]
153
196
  */
154
197
  /**
155
- * @typedef GetOneOrAllQuery
156
- * @property {string} [city]
157
- * @property {string} [country]
158
- * @property {string} [sector]
159
- * @property {string} [state]
160
- */
161
- /**
162
- * @typedef GetStoreResponse
163
- * @property {StoreItemResponse[]} [items]
164
- * @property {Page} [page]
198
+ * @typedef CountryListResponse
199
+ * @property {CountryEntityResponse[]} [results]
165
200
  */
166
201
  /**
167
202
  * @typedef GetZoneFromPincodeViewRequest
168
- * @property {string} country
169
203
  * @property {string} pincode
204
+ * @property {string} country
170
205
  */
171
206
  /**
172
207
  * @typedef GetZoneFromPincodeViewResponse
@@ -174,240 +209,282 @@ export = LogisticApplicationModel;
174
209
  * @property {string[]} zones
175
210
  */
176
211
  /**
177
- * @typedef LengthValidation
178
- * @property {number} [max]
179
- * @property {number} [min]
212
+ * @typedef ReAssignStoreRequest
213
+ * @property {Object} configuration
214
+ * @property {string} to_pincode
215
+ * @property {number[]} ignored_locations
216
+ * @property {string} identifier
217
+ * @property {Object[]} articles
180
218
  */
181
219
  /**
182
- * @typedef Localities
183
- * @property {string} [display_name]
184
- * @property {string} [id]
185
- * @property {string} [name]
186
- * @property {string[]} [parent_ids]
187
- * @property {string} [type]
220
+ * @typedef ReAssignStoreResponse
221
+ * @property {string} to_pincode
222
+ * @property {string} pystormbreaker_uuid
223
+ * @property {boolean} success
224
+ * @property {Object} error
225
+ * @property {Object[]} [assigned_stores]
188
226
  */
189
227
  /**
190
- * @typedef LocalityParent
191
- * @property {string} [display_name]
192
- * @property {string} [id]
228
+ * @typedef CountryHierarchy
193
229
  * @property {string} [name]
194
- * @property {string[]} [parent_ids]
195
- * @property {string} [type]
230
+ * @property {string} [slug]
196
231
  */
197
232
  /**
198
- * @typedef LogisticsResponse
199
- * @property {Object} [dp]
233
+ * @typedef CurrencyObject
234
+ * @property {string} [code]
235
+ * @property {string} [name]
236
+ * @property {string} [symbol]
200
237
  */
201
238
  /**
202
- * @typedef Page
203
- * @property {number} [current]
204
- * @property {boolean} [has_next]
205
- * @property {boolean} [has_previous]
206
- * @property {number} [item_total]
207
- * @property {string} [next_id]
208
- * @property {number} [size]
209
- * @property {string} type
239
+ * @typedef CountryObject
240
+ * @property {string} [id]
241
+ * @property {string} [name]
242
+ * @property {string} [display_name]
243
+ * @property {string} [iso2]
244
+ * @property {string} [iso3]
245
+ * @property {string[]} [timezones]
246
+ * @property {CountryHierarchy[]} [hierarchy]
247
+ * @property {string} [phone_code]
248
+ * @property {string} [latitude]
249
+ * @property {string} [longitude]
250
+ * @property {CurrencyObject} [currency]
251
+ * @property {string} [type]
210
252
  */
211
253
  /**
212
- * @typedef PincodeApiResponse
213
- * @property {PincodeDataResponse[]} [data]
214
- * @property {PincodeErrorSchemaResponse} error
215
- * @property {boolean} success
254
+ * @typedef GetCountries
255
+ * @property {CountryObject[]} [items]
256
+ * @property {Page} [page]
216
257
  */
217
258
  /**
218
- * @typedef PincodeDataResponse
219
- * @property {string} [display_name]
220
- * @property {PincodeErrorSchemaResponse} error
221
- * @property {PincodeLatLongData} [lat_long]
222
- * @property {PincodeMetaResponse} [meta]
223
- * @property {CountryMetaResponse} [meta_code]
224
- * @property {string} [name]
225
- * @property {PincodeParentsResponse[]} [parents]
226
- * @property {string} [sub_type]
227
- * @property {string} [uid]
259
+ * @typedef GetOneOrAllPath
260
+ * @property {string} [locality_type]
261
+ * @property {string} [locality_value]
228
262
  */
229
263
  /**
230
- * @typedef PincodeErrorSchemaResponse
231
- * @property {string} [message]
232
- * @property {string} [type]
233
- * @property {string} [value]
264
+ * @typedef GetOneOrAllQuery
265
+ * @property {string} [country]
266
+ * @property {string} [state]
267
+ * @property {string} [city]
268
+ * @property {string} [sector]
234
269
  */
235
270
  /**
236
- * @typedef PincodeLatLongData
237
- * @property {string[]} [coordinates]
238
- * @property {string} [type]
271
+ * @typedef GetOneOrAllParams
272
+ * @property {GetOneOrAllPath} [path]
273
+ * @property {GetOneOrAllQuery} [query]
239
274
  */
240
275
  /**
241
- * @typedef PincodeMetaResponse
242
- * @property {number} [internal_zone_id]
243
- * @property {string} [zone]
276
+ * @typedef GetOneOrAll
277
+ * @property {string} [operation_id]
278
+ * @property {GetOneOrAllParams} [params]
244
279
  */
245
280
  /**
246
- * @typedef PincodeParentsResponse
247
- * @property {string} [display_name]
248
- * @property {string} [name]
249
- * @property {string} [sub_type]
250
- * @property {string} [uid]
281
+ * @typedef LengthValidation
282
+ * @property {number} [min]
283
+ * @property {number} [max]
251
284
  */
252
285
  /**
253
- * @typedef ReAssignStoreRequest
254
- * @property {Object[]} articles
255
- * @property {Object} configuration
256
- * @property {string} identifier
257
- * @property {number[]} ignored_locations
258
- * @property {string} to_pincode
286
+ * @typedef FieldValidationRegex
287
+ * @property {string} [value]
288
+ * @property {LengthValidation} [length]
259
289
  */
260
290
  /**
261
- * @typedef ReAssignStoreResponse
262
- * @property {Object[]} [assigned_stores]
263
- * @property {Object} error
264
- * @property {string} pystormbreaker_uuid
265
- * @property {boolean} success
266
- * @property {string} to_pincode
291
+ * @typedef FieldValidation
292
+ * @property {string} [type]
293
+ * @property {FieldValidationRegex} [regex]
267
294
  */
268
295
  /**
269
- * @typedef StoreItemResponse
270
- * @property {number} [company_id]
271
- * @property {string} [fulfillment_type]
272
- * @property {number} [id]
273
- * @property {number} [latitude]
274
- * @property {number} [longitude]
275
- * @property {number} [processing_time]
276
- * @property {string} [store_type]
277
- * @property {string[]} [tags]
296
+ * @typedef GetCountryFieldsAddressValues
297
+ * @property {GetOneOrAll} [get_one]
298
+ * @property {GetOneOrAll} [get_all]
278
299
  */
279
300
  /**
280
- * @typedef TATArticlesRequest
281
- * @property {TATCategoryRequest} [category]
282
- * @property {number} [manufacturing_time]
283
- * @property {string} [manufacturing_time_unit]
301
+ * @typedef GetCountryFieldsAddress
302
+ * @property {string} display_name
303
+ * @property {string} slug
304
+ * @property {boolean} required
305
+ * @property {boolean} [edit]
306
+ * @property {string} input
307
+ * @property {FieldValidation} [validation]
308
+ * @property {GetCountryFieldsAddressValues} [values]
309
+ * @property {string} [error_text]
284
310
  */
285
311
  /**
286
- * @typedef TATArticlesResponse
287
- * @property {number} [_manufacturing_time_seconds]
288
- * @property {TATCategoryRequest} [category]
289
- * @property {TATErrorSchemaResponse} [error]
290
- * @property {boolean} [is_cod_available]
291
- * @property {number} [manufacturing_time]
292
- * @property {string} [manufacturing_time_unit]
293
- * @property {TATPromiseResponse} [promise]
312
+ * @typedef GetCountryFieldsAddressTemplate
313
+ * @property {string} checkout_form
314
+ * @property {string} store_os_form
315
+ * @property {string} default_display
294
316
  */
295
317
  /**
296
- * @typedef TATCategoryRequest
297
- * @property {number} [id]
298
- * @property {string} [level]
318
+ * @typedef GetCountryFields
319
+ * @property {GetCountryFieldsAddress[]} address
320
+ * @property {string[]} serviceability_fields
321
+ * @property {GetCountryFieldsAddressTemplate} address_template
299
322
  */
300
323
  /**
301
- * @typedef TATErrorSchemaResponse
302
- * @property {string} [message]
324
+ * @typedef GetCountry
325
+ * @property {string} [id]
326
+ * @property {string} [name]
327
+ * @property {string} [display_name]
328
+ * @property {string} [iso2]
329
+ * @property {string} [iso3]
330
+ * @property {string[]} [timezones]
331
+ * @property {CountryHierarchy[]} [hierarchy]
332
+ * @property {string} [phone_code]
333
+ * @property {string} [latitude]
334
+ * @property {string} [longitude]
335
+ * @property {CurrencyObject} [currency]
303
336
  * @property {string} [type]
304
- * @property {string} [value]
337
+ * @property {GetCountryFields} [fields]
305
338
  */
306
339
  /**
307
- * @typedef TATFormattedResponse
308
- * @property {string} [max]
309
- * @property {string} [min]
340
+ * @typedef Page
341
+ * @property {number} [item_total]
342
+ * @property {string} [next_id]
343
+ * @property {boolean} [has_previous]
344
+ * @property {boolean} [has_next]
345
+ * @property {number} [current]
346
+ * @property {string} type
347
+ * @property {number} [size]
310
348
  */
311
349
  /**
312
- * @typedef TATLocationDetailsRequest
313
- * @property {TATArticlesRequest[]} [articles]
314
- * @property {string} [from_pincode]
315
- * @property {number} [fulfillment_id]
350
+ * @typedef Localities
351
+ * @property {string} [id]
352
+ * @property {string} [name]
353
+ * @property {string} [display_name]
354
+ * @property {string[]} [parent_ids]
355
+ * @property {string} [type]
316
356
  */
317
357
  /**
318
- * @typedef TATLocationDetailsResponse
319
- * @property {TATArticlesResponse[]} [articles]
320
- * @property {string} [from_pincode]
321
- * @property {number} [fulfillment_id]
358
+ * @typedef LocalityParent
359
+ * @property {string} [id]
360
+ * @property {string} [name]
361
+ * @property {string} [display_name]
362
+ * @property {string[]} [parent_ids]
363
+ * @property {string} [type]
322
364
  */
323
365
  /**
324
- * @typedef TATPromiseResponse
325
- * @property {TATFormattedResponse} [formatted]
326
- * @property {TATTimestampResponse} [timestamp]
366
+ * @typedef GetLocalities
367
+ * @property {Localities[]} [items]
368
+ * @property {Page} [page]
327
369
  */
328
370
  /**
329
- * @typedef TATTimestampResponse
330
- * @property {number} [max]
331
- * @property {number} [min]
371
+ * @typedef GetLocality
372
+ * @property {string} [id]
373
+ * @property {string} [name]
374
+ * @property {string} [display_name]
375
+ * @property {string[]} [parent_ids]
376
+ * @property {string} [type]
377
+ * @property {LocalityParent[]} [localities]
332
378
  */
333
379
  /**
334
- * @typedef TATViewRequest
335
- * @property {string} [action]
336
- * @property {string} [identifier]
337
- * @property {string} [journey]
338
- * @property {TATLocationDetailsRequest[]} [location_details]
339
- * @property {string} [source]
340
- * @property {string} [to_pincode]
341
- */
342
- /**
343
- * @typedef TATViewResponse
344
- * @property {string} [action]
345
- * @property {TATErrorSchemaResponse} [error]
346
- * @property {string} [identifier]
347
- * @property {boolean} [is_cod_available]
348
- * @property {string} [journey]
349
- * @property {TATLocationDetailsResponse[]} [location_details]
350
- * @property {string} [payment_mode]
351
- * @property {string} [request_uuid]
352
- * @property {string} [source]
353
- * @property {string} [stormbreaker_uuid]
354
- * @property {boolean} [success]
355
- * @property {string} [to_city]
356
- * @property {string} [to_pincode]
357
- */
358
- /**
359
- * @typedef ValidateAddressRequest
360
- * @property {string} [address] - A string representing the complete address,
361
- * combining address line 1, address line 2, area, landmark, sector, city,
362
- * state, and pincode. This provides a comprehensive view of the address details.
363
- * @property {string} [address1] - A string representing the first line of the
364
- * address, typically containing street or building information.
365
- * @property {string} [address2] - A string representing the second line of the
366
- * address, which can be used for additional address details if needed.
367
- * @property {string} [area] - A string specifying the locality or area
368
- * associated with the address.
369
- * @property {string} [city] - A string denoting the city or municipality of the address.
370
- * @property {string} [email] - A string containing the recipient's email address.
371
- * @property {string} [landmark] - A string representing a prominent nearby
372
- * landmark that aids in locating the address.
373
- * @property {string} [name] - A string representing the recipient's name or the
374
- * organization name associated with the address.
375
- * @property {string} [phone] - An integer representing the recipient's contact
376
- * phone number.
377
- * @property {string} [pincode] - A string indicating the postal code or PIN
378
- * code of the address area.
379
- * @property {string} [sector] - A string specifying the sector or district of
380
- * the address if applicable.
381
- * @property {string} [state] - A string indicating the state or province of the address.
380
+ * @typedef ErrorResponse
381
+ * @property {string} [error]
382
382
  */
383
383
  declare class LogisticApplicationModel {
384
384
  }
385
385
  declare namespace LogisticApplicationModel {
386
- export { CountryEntityResponse, CountryHierarchy, CountryListResponse, CountryMetaResponse, CountryObject, CurrencyObject, DP, ErrorResponse, FieldValidation, FieldValidationRegex, GetCountries, GetCountry, GetCountryFields, GetCountryFieldsAddress, GetCountryFieldsAddressTemplate, GetCountryFieldsAddressValues, GetLocalities, GetLocality, GetOneOrAll, GetOneOrAllParams, GetOneOrAllPath, GetOneOrAllQuery, GetStoreResponse, GetZoneFromPincodeViewRequest, GetZoneFromPincodeViewResponse, LengthValidation, Localities, LocalityParent, LogisticsResponse, Page, PincodeApiResponse, PincodeDataResponse, PincodeErrorSchemaResponse, PincodeLatLongData, PincodeMetaResponse, PincodeParentsResponse, ReAssignStoreRequest, ReAssignStoreResponse, StoreItemResponse, TATArticlesRequest, TATArticlesResponse, TATCategoryRequest, TATErrorSchemaResponse, TATFormattedResponse, TATLocationDetailsRequest, TATLocationDetailsResponse, TATPromiseResponse, TATTimestampResponse, TATViewRequest, TATViewResponse, ValidateAddressRequest };
386
+ export { GetStoreResponse, StoreItemResponse, ValidateAddressRequest, PincodeParentsResponse, PincodeMetaResponse, PincodeErrorSchemaResponse, CountryMetaResponse, PincodeLatLongData, PincodeDataResponse, PincodeApiResponse, TATCategoryRequest, TATArticlesRequest, TATLocationDetailsRequest, TATViewRequest, TATErrorSchemaResponse, TATTimestampResponse, TATFormattedResponse, TATPromiseResponse, TATArticlesResponse, TATLocationDetailsResponse, TATViewResponse, DP, LogisticsResponse, CountryEntityResponse, CountryListResponse, GetZoneFromPincodeViewRequest, GetZoneFromPincodeViewResponse, ReAssignStoreRequest, ReAssignStoreResponse, CountryHierarchy, CurrencyObject, CountryObject, GetCountries, GetOneOrAllPath, GetOneOrAllQuery, GetOneOrAllParams, GetOneOrAll, LengthValidation, FieldValidationRegex, FieldValidation, GetCountryFieldsAddressValues, GetCountryFieldsAddress, GetCountryFieldsAddressTemplate, GetCountryFields, GetCountry, Page, Localities, LocalityParent, GetLocalities, GetLocality, ErrorResponse };
387
387
  }
388
- /** @returns {CountryEntityResponse} */
389
- declare function CountryEntityResponse(): CountryEntityResponse;
390
- type CountryEntityResponse = {
391
- display_name?: string;
392
- is_active?: boolean;
393
- logistics?: LogisticsResponse;
394
- meta?: CountryMetaResponse;
388
+ /** @returns {GetStoreResponse} */
389
+ declare function GetStoreResponse(): GetStoreResponse;
390
+ type GetStoreResponse = {
391
+ items?: StoreItemResponse[];
392
+ page?: Page;
393
+ };
394
+ /** @returns {StoreItemResponse} */
395
+ declare function StoreItemResponse(): StoreItemResponse;
396
+ type StoreItemResponse = {
397
+ id?: number;
398
+ store_type?: string;
399
+ fulfillment_type?: string;
400
+ processing_time?: number;
401
+ tags?: string[];
402
+ company_id?: number;
403
+ latitude?: number;
404
+ longitude?: number;
405
+ };
406
+ /** @returns {ValidateAddressRequest} */
407
+ declare function ValidateAddressRequest(): ValidateAddressRequest;
408
+ type ValidateAddressRequest = {
409
+ /**
410
+ * - A string representing the complete address,
411
+ * combining address line 1, address line 2, area, landmark, sector, city,
412
+ * state, and pincode. This provides a comprehensive view of the address details.
413
+ */
414
+ address?: string;
415
+ /**
416
+ * - A string representing the first line of the
417
+ * address, typically containing street or building information.
418
+ */
419
+ address1?: string;
420
+ /**
421
+ * - A string representing the second line of the
422
+ * address, which can be used for additional address details if needed.
423
+ */
424
+ address2?: string;
425
+ /**
426
+ * - A string specifying the locality or area
427
+ * associated with the address.
428
+ */
429
+ area?: string;
430
+ /**
431
+ * - A string representing a prominent nearby
432
+ * landmark that aids in locating the address.
433
+ */
434
+ landmark?: string;
435
+ /**
436
+ * - A string indicating the postal code or PIN
437
+ * code of the address area.
438
+ */
439
+ pincode?: string;
440
+ /**
441
+ * - A string specifying the sector or district of
442
+ * the address if applicable.
443
+ */
444
+ sector?: string;
445
+ /**
446
+ * - A string denoting the city or municipality of the address.
447
+ */
448
+ city?: string;
449
+ /**
450
+ * - A string indicating the state or province of the address.
451
+ */
452
+ state?: string;
453
+ /**
454
+ * - A string representing the recipient's name or the
455
+ * organization name associated with the address.
456
+ */
395
457
  name?: string;
396
- parent_id?: string;
458
+ /**
459
+ * - An integer representing the recipient's contact
460
+ * phone number.
461
+ */
462
+ phone?: string;
463
+ /**
464
+ * - A string containing the recipient's email address.
465
+ */
466
+ email?: string;
467
+ };
468
+ /** @returns {PincodeParentsResponse} */
469
+ declare function PincodeParentsResponse(): PincodeParentsResponse;
470
+ type PincodeParentsResponse = {
397
471
  sub_type?: string;
398
- type?: string;
472
+ display_name?: string;
473
+ name?: string;
399
474
  uid?: string;
400
475
  };
401
- /** @returns {CountryHierarchy} */
402
- declare function CountryHierarchy(): CountryHierarchy;
403
- type CountryHierarchy = {
404
- name?: string;
405
- slug?: string;
476
+ /** @returns {PincodeMetaResponse} */
477
+ declare function PincodeMetaResponse(): PincodeMetaResponse;
478
+ type PincodeMetaResponse = {
479
+ zone?: string;
480
+ internal_zone_id?: number;
406
481
  };
407
- /** @returns {CountryListResponse} */
408
- declare function CountryListResponse(): CountryListResponse;
409
- type CountryListResponse = {
410
- results?: CountryEntityResponse[];
482
+ /** @returns {PincodeErrorSchemaResponse} */
483
+ declare function PincodeErrorSchemaResponse(): PincodeErrorSchemaResponse;
484
+ type PincodeErrorSchemaResponse = {
485
+ message?: string;
486
+ value?: string;
487
+ type?: string;
411
488
  };
412
489
  /** @returns {CountryMetaResponse} */
413
490
  declare function CountryMetaResponse(): CountryMetaResponse;
@@ -415,142 +492,223 @@ type CountryMetaResponse = {
415
492
  country_code?: string;
416
493
  isd_code?: string;
417
494
  };
418
- /** @returns {CountryObject} */
419
- declare function CountryObject(): CountryObject;
420
- type CountryObject = {
421
- currency?: CurrencyObject;
422
- display_name?: string;
423
- hierarchy?: CountryHierarchy[];
424
- id?: string;
425
- iso2?: string;
426
- iso3?: string;
427
- latitude?: string;
428
- longitude?: string;
429
- name?: string;
430
- phone_code?: string;
431
- timezones?: string[];
495
+ /** @returns {PincodeLatLongData} */
496
+ declare function PincodeLatLongData(): PincodeLatLongData;
497
+ type PincodeLatLongData = {
432
498
  type?: string;
499
+ coordinates?: string[];
433
500
  };
434
- /** @returns {CurrencyObject} */
435
- declare function CurrencyObject(): CurrencyObject;
436
- type CurrencyObject = {
437
- code?: string;
501
+ /** @returns {PincodeDataResponse} */
502
+ declare function PincodeDataResponse(): PincodeDataResponse;
503
+ type PincodeDataResponse = {
504
+ parents?: PincodeParentsResponse[];
505
+ meta?: PincodeMetaResponse;
506
+ display_name?: string;
507
+ error: PincodeErrorSchemaResponse;
508
+ meta_code?: CountryMetaResponse;
509
+ lat_long?: PincodeLatLongData;
510
+ sub_type?: string;
438
511
  name?: string;
439
- symbol?: string;
512
+ uid?: string;
440
513
  };
441
- /** @returns {DP} */
442
- declare function DP(): DP;
443
- type DP = {
444
- area_code?: string;
445
- assign_dp_from_sb?: boolean;
446
- external_account_id?: string;
447
- fm_priority: number;
448
- internal_account_id?: string;
449
- lm_priority: number;
450
- operations: string[];
451
- payment_mode: string;
452
- rvp_priority: number;
453
- transport_mode?: string;
514
+ /** @returns {PincodeApiResponse} */
515
+ declare function PincodeApiResponse(): PincodeApiResponse;
516
+ type PincodeApiResponse = {
517
+ success: boolean;
518
+ data?: PincodeDataResponse[];
519
+ error: PincodeErrorSchemaResponse;
454
520
  };
455
- /** @returns {ErrorResponse} */
456
- declare function ErrorResponse(): ErrorResponse;
457
- type ErrorResponse = {
458
- error?: string;
521
+ /** @returns {TATCategoryRequest} */
522
+ declare function TATCategoryRequest(): TATCategoryRequest;
523
+ type TATCategoryRequest = {
524
+ level?: string;
525
+ id?: number;
459
526
  };
460
- /** @returns {FieldValidation} */
461
- declare function FieldValidation(): FieldValidation;
462
- type FieldValidation = {
463
- regex?: FieldValidationRegex;
464
- type?: string;
527
+ /** @returns {TATArticlesRequest} */
528
+ declare function TATArticlesRequest(): TATArticlesRequest;
529
+ type TATArticlesRequest = {
530
+ category?: TATCategoryRequest;
531
+ manufacturing_time_unit?: string;
532
+ manufacturing_time?: number;
465
533
  };
466
- /** @returns {FieldValidationRegex} */
467
- declare function FieldValidationRegex(): FieldValidationRegex;
468
- type FieldValidationRegex = {
469
- length?: LengthValidation;
534
+ /** @returns {TATLocationDetailsRequest} */
535
+ declare function TATLocationDetailsRequest(): TATLocationDetailsRequest;
536
+ type TATLocationDetailsRequest = {
537
+ fulfillment_id?: number;
538
+ from_pincode?: string;
539
+ articles?: TATArticlesRequest[];
540
+ };
541
+ /** @returns {TATViewRequest} */
542
+ declare function TATViewRequest(): TATViewRequest;
543
+ type TATViewRequest = {
544
+ to_pincode?: string;
545
+ source?: string;
546
+ action?: string;
547
+ identifier?: string;
548
+ location_details?: TATLocationDetailsRequest[];
549
+ journey?: string;
550
+ };
551
+ /** @returns {TATErrorSchemaResponse} */
552
+ declare function TATErrorSchemaResponse(): TATErrorSchemaResponse;
553
+ type TATErrorSchemaResponse = {
554
+ message?: string;
470
555
  value?: string;
556
+ type?: string;
471
557
  };
472
- /** @returns {GetCountries} */
473
- declare function GetCountries(): GetCountries;
474
- type GetCountries = {
475
- items?: CountryObject[];
476
- page?: Page;
558
+ /** @returns {TATTimestampResponse} */
559
+ declare function TATTimestampResponse(): TATTimestampResponse;
560
+ type TATTimestampResponse = {
561
+ min?: number;
562
+ max?: number;
477
563
  };
478
- /** @returns {GetCountry} */
479
- declare function GetCountry(): GetCountry;
480
- type GetCountry = {
481
- currency?: CurrencyObject;
482
- display_name?: string;
483
- fields?: GetCountryFields;
484
- hierarchy?: CountryHierarchy[];
485
- id?: string;
486
- iso2?: string;
487
- iso3?: string;
488
- latitude?: string;
489
- longitude?: string;
490
- name?: string;
491
- phone_code?: string;
492
- timezones?: string[];
493
- type?: string;
564
+ /** @returns {TATFormattedResponse} */
565
+ declare function TATFormattedResponse(): TATFormattedResponse;
566
+ type TATFormattedResponse = {
567
+ min?: string;
568
+ max?: string;
494
569
  };
495
- /** @returns {GetCountryFields} */
496
- declare function GetCountryFields(): GetCountryFields;
497
- type GetCountryFields = {
498
- address: GetCountryFieldsAddress[];
499
- address_template: GetCountryFieldsAddressTemplate;
500
- serviceability_fields: string[];
570
+ /** @returns {TATPromiseResponse} */
571
+ declare function TATPromiseResponse(): TATPromiseResponse;
572
+ type TATPromiseResponse = {
573
+ timestamp?: TATTimestampResponse;
574
+ formatted?: TATFormattedResponse;
501
575
  };
502
- /** @returns {GetCountryFieldsAddress} */
503
- declare function GetCountryFieldsAddress(): GetCountryFieldsAddress;
504
- type GetCountryFieldsAddress = {
505
- display_name: string;
506
- edit?: boolean;
507
- error_text?: string;
508
- input: string;
509
- required: boolean;
510
- slug: string;
511
- validation?: FieldValidation;
512
- values?: GetCountryFieldsAddressValues;
576
+ /** @returns {TATArticlesResponse} */
577
+ declare function TATArticlesResponse(): TATArticlesResponse;
578
+ type TATArticlesResponse = {
579
+ manufacturing_time_unit?: string;
580
+ error?: TATErrorSchemaResponse;
581
+ is_cod_available?: boolean;
582
+ promise?: TATPromiseResponse;
583
+ manufacturing_time?: number;
584
+ category?: TATCategoryRequest;
585
+ _manufacturing_time_seconds?: number;
513
586
  };
514
- /** @returns {GetCountryFieldsAddressTemplate} */
515
- declare function GetCountryFieldsAddressTemplate(): GetCountryFieldsAddressTemplate;
516
- type GetCountryFieldsAddressTemplate = {
517
- checkout_form: string;
518
- default_display: string;
519
- store_os_form: string;
587
+ /** @returns {TATLocationDetailsResponse} */
588
+ declare function TATLocationDetailsResponse(): TATLocationDetailsResponse;
589
+ type TATLocationDetailsResponse = {
590
+ fulfillment_id?: number;
591
+ from_pincode?: string;
592
+ articles?: TATArticlesResponse[];
520
593
  };
521
- /** @returns {GetCountryFieldsAddressValues} */
522
- declare function GetCountryFieldsAddressValues(): GetCountryFieldsAddressValues;
523
- type GetCountryFieldsAddressValues = {
524
- get_all?: GetOneOrAll;
525
- get_one?: GetOneOrAll;
594
+ /** @returns {TATViewResponse} */
595
+ declare function TATViewResponse(): TATViewResponse;
596
+ type TATViewResponse = {
597
+ to_pincode?: string;
598
+ request_uuid?: string;
599
+ payment_mode?: string;
600
+ success?: boolean;
601
+ error?: TATErrorSchemaResponse;
602
+ is_cod_available?: boolean;
603
+ source?: string;
604
+ action?: string;
605
+ stormbreaker_uuid?: string;
606
+ to_city?: string;
607
+ identifier?: string;
608
+ location_details?: TATLocationDetailsResponse[];
609
+ journey?: string;
526
610
  };
527
- /** @returns {GetLocalities} */
528
- declare function GetLocalities(): GetLocalities;
529
- type GetLocalities = {
530
- items?: Localities[];
531
- page?: Page;
611
+ /** @returns {DP} */
612
+ declare function DP(): DP;
613
+ type DP = {
614
+ fm_priority: number;
615
+ lm_priority: number;
616
+ rvp_priority: number;
617
+ payment_mode: string;
618
+ operations: string[];
619
+ area_code?: string;
620
+ assign_dp_from_sb?: boolean;
621
+ internal_account_id?: string;
622
+ external_account_id?: string;
623
+ transport_mode?: string;
532
624
  };
533
- /** @returns {GetLocality} */
534
- declare function GetLocality(): GetLocality;
535
- type GetLocality = {
625
+ /** @returns {LogisticsResponse} */
626
+ declare function LogisticsResponse(): LogisticsResponse;
627
+ type LogisticsResponse = {
628
+ dp?: any;
629
+ };
630
+ /** @returns {CountryEntityResponse} */
631
+ declare function CountryEntityResponse(): CountryEntityResponse;
632
+ type CountryEntityResponse = {
633
+ meta?: CountryMetaResponse;
634
+ logistics?: LogisticsResponse;
536
635
  display_name?: string;
636
+ type?: string;
637
+ is_active?: boolean;
638
+ parent_id?: string;
639
+ sub_type?: string;
640
+ name?: string;
641
+ uid?: string;
642
+ };
643
+ /** @returns {CountryListResponse} */
644
+ declare function CountryListResponse(): CountryListResponse;
645
+ type CountryListResponse = {
646
+ results?: CountryEntityResponse[];
647
+ };
648
+ /** @returns {GetZoneFromPincodeViewRequest} */
649
+ declare function GetZoneFromPincodeViewRequest(): GetZoneFromPincodeViewRequest;
650
+ type GetZoneFromPincodeViewRequest = {
651
+ pincode: string;
652
+ country: string;
653
+ };
654
+ /** @returns {GetZoneFromPincodeViewResponse} */
655
+ declare function GetZoneFromPincodeViewResponse(): GetZoneFromPincodeViewResponse;
656
+ type GetZoneFromPincodeViewResponse = {
657
+ serviceability_type: string;
658
+ zones: string[];
659
+ };
660
+ /** @returns {ReAssignStoreRequest} */
661
+ declare function ReAssignStoreRequest(): ReAssignStoreRequest;
662
+ type ReAssignStoreRequest = {
663
+ configuration: any;
664
+ to_pincode: string;
665
+ ignored_locations: number[];
666
+ identifier: string;
667
+ articles: any[];
668
+ };
669
+ /** @returns {ReAssignStoreResponse} */
670
+ declare function ReAssignStoreResponse(): ReAssignStoreResponse;
671
+ type ReAssignStoreResponse = {
672
+ to_pincode: string;
673
+ pystormbreaker_uuid: string;
674
+ success: boolean;
675
+ error: any;
676
+ assigned_stores?: any[];
677
+ };
678
+ /** @returns {CountryHierarchy} */
679
+ declare function CountryHierarchy(): CountryHierarchy;
680
+ type CountryHierarchy = {
681
+ name?: string;
682
+ slug?: string;
683
+ };
684
+ /** @returns {CurrencyObject} */
685
+ declare function CurrencyObject(): CurrencyObject;
686
+ type CurrencyObject = {
687
+ code?: string;
688
+ name?: string;
689
+ symbol?: string;
690
+ };
691
+ /** @returns {CountryObject} */
692
+ declare function CountryObject(): CountryObject;
693
+ type CountryObject = {
537
694
  id?: string;
538
- localities?: LocalityParent[];
539
695
  name?: string;
540
- parent_ids?: string[];
696
+ display_name?: string;
697
+ iso2?: string;
698
+ iso3?: string;
699
+ timezones?: string[];
700
+ hierarchy?: CountryHierarchy[];
701
+ phone_code?: string;
702
+ latitude?: string;
703
+ longitude?: string;
704
+ currency?: CurrencyObject;
541
705
  type?: string;
542
706
  };
543
- /** @returns {GetOneOrAll} */
544
- declare function GetOneOrAll(): GetOneOrAll;
545
- type GetOneOrAll = {
546
- operation_id?: string;
547
- params?: GetOneOrAllParams;
548
- };
549
- /** @returns {GetOneOrAllParams} */
550
- declare function GetOneOrAllParams(): GetOneOrAllParams;
551
- type GetOneOrAllParams = {
552
- path?: GetOneOrAllPath;
553
- query?: GetOneOrAllQuery;
707
+ /** @returns {GetCountries} */
708
+ declare function GetCountries(): GetCountries;
709
+ type GetCountries = {
710
+ items?: CountryObject[];
711
+ page?: Page;
554
712
  };
555
713
  /** @returns {GetOneOrAllPath} */
556
714
  declare function GetOneOrAllPath(): GetOneOrAllPath;
@@ -561,295 +719,137 @@ type GetOneOrAllPath = {
561
719
  /** @returns {GetOneOrAllQuery} */
562
720
  declare function GetOneOrAllQuery(): GetOneOrAllQuery;
563
721
  type GetOneOrAllQuery = {
564
- city?: string;
565
722
  country?: string;
566
- sector?: string;
567
723
  state?: string;
724
+ city?: string;
725
+ sector?: string;
568
726
  };
569
- /** @returns {GetStoreResponse} */
570
- declare function GetStoreResponse(): GetStoreResponse;
571
- type GetStoreResponse = {
572
- items?: StoreItemResponse[];
573
- page?: Page;
574
- };
575
- /** @returns {GetZoneFromPincodeViewRequest} */
576
- declare function GetZoneFromPincodeViewRequest(): GetZoneFromPincodeViewRequest;
577
- type GetZoneFromPincodeViewRequest = {
578
- country: string;
579
- pincode: string;
727
+ /** @returns {GetOneOrAllParams} */
728
+ declare function GetOneOrAllParams(): GetOneOrAllParams;
729
+ type GetOneOrAllParams = {
730
+ path?: GetOneOrAllPath;
731
+ query?: GetOneOrAllQuery;
580
732
  };
581
- /** @returns {GetZoneFromPincodeViewResponse} */
582
- declare function GetZoneFromPincodeViewResponse(): GetZoneFromPincodeViewResponse;
583
- type GetZoneFromPincodeViewResponse = {
584
- serviceability_type: string;
585
- zones: string[];
733
+ /** @returns {GetOneOrAll} */
734
+ declare function GetOneOrAll(): GetOneOrAll;
735
+ type GetOneOrAll = {
736
+ operation_id?: string;
737
+ params?: GetOneOrAllParams;
586
738
  };
587
739
  /** @returns {LengthValidation} */
588
740
  declare function LengthValidation(): LengthValidation;
589
741
  type LengthValidation = {
590
- max?: number;
591
742
  min?: number;
743
+ max?: number;
592
744
  };
593
- /** @returns {Localities} */
594
- declare function Localities(): Localities;
595
- type Localities = {
596
- display_name?: string;
597
- id?: string;
598
- name?: string;
599
- parent_ids?: string[];
600
- type?: string;
745
+ /** @returns {FieldValidationRegex} */
746
+ declare function FieldValidationRegex(): FieldValidationRegex;
747
+ type FieldValidationRegex = {
748
+ value?: string;
749
+ length?: LengthValidation;
601
750
  };
602
- /** @returns {LocalityParent} */
603
- declare function LocalityParent(): LocalityParent;
604
- type LocalityParent = {
605
- display_name?: string;
606
- id?: string;
607
- name?: string;
608
- parent_ids?: string[];
751
+ /** @returns {FieldValidation} */
752
+ declare function FieldValidation(): FieldValidation;
753
+ type FieldValidation = {
609
754
  type?: string;
755
+ regex?: FieldValidationRegex;
610
756
  };
611
- /** @returns {LogisticsResponse} */
612
- declare function LogisticsResponse(): LogisticsResponse;
613
- type LogisticsResponse = {
614
- dp?: any;
615
- };
616
- /** @returns {Page} */
757
+ /** @returns {GetCountryFieldsAddressValues} */
758
+ declare function GetCountryFieldsAddressValues(): GetCountryFieldsAddressValues;
759
+ type GetCountryFieldsAddressValues = {
760
+ get_one?: GetOneOrAll;
761
+ get_all?: GetOneOrAll;
762
+ };
763
+ /** @returns {GetCountryFieldsAddress} */
764
+ declare function GetCountryFieldsAddress(): GetCountryFieldsAddress;
765
+ type GetCountryFieldsAddress = {
766
+ display_name: string;
767
+ slug: string;
768
+ required: boolean;
769
+ edit?: boolean;
770
+ input: string;
771
+ validation?: FieldValidation;
772
+ values?: GetCountryFieldsAddressValues;
773
+ error_text?: string;
774
+ };
775
+ /** @returns {GetCountryFieldsAddressTemplate} */
776
+ declare function GetCountryFieldsAddressTemplate(): GetCountryFieldsAddressTemplate;
777
+ type GetCountryFieldsAddressTemplate = {
778
+ checkout_form: string;
779
+ store_os_form: string;
780
+ default_display: string;
781
+ };
782
+ /** @returns {GetCountryFields} */
783
+ declare function GetCountryFields(): GetCountryFields;
784
+ type GetCountryFields = {
785
+ address: GetCountryFieldsAddress[];
786
+ serviceability_fields: string[];
787
+ address_template: GetCountryFieldsAddressTemplate;
788
+ };
789
+ /** @returns {GetCountry} */
790
+ declare function GetCountry(): GetCountry;
791
+ type GetCountry = {
792
+ id?: string;
793
+ name?: string;
794
+ display_name?: string;
795
+ iso2?: string;
796
+ iso3?: string;
797
+ timezones?: string[];
798
+ hierarchy?: CountryHierarchy[];
799
+ phone_code?: string;
800
+ latitude?: string;
801
+ longitude?: string;
802
+ currency?: CurrencyObject;
803
+ type?: string;
804
+ fields?: GetCountryFields;
805
+ };
806
+ /** @returns {Page} */
617
807
  declare function Page(): Page;
618
808
  type Page = {
619
- current?: number;
620
- has_next?: boolean;
621
- has_previous?: boolean;
622
809
  item_total?: number;
623
810
  next_id?: string;
624
- size?: number;
811
+ has_previous?: boolean;
812
+ has_next?: boolean;
813
+ current?: number;
625
814
  type: string;
815
+ size?: number;
626
816
  };
627
- /** @returns {PincodeApiResponse} */
628
- declare function PincodeApiResponse(): PincodeApiResponse;
629
- type PincodeApiResponse = {
630
- data?: PincodeDataResponse[];
631
- error: PincodeErrorSchemaResponse;
632
- success: boolean;
633
- };
634
- /** @returns {PincodeDataResponse} */
635
- declare function PincodeDataResponse(): PincodeDataResponse;
636
- type PincodeDataResponse = {
637
- display_name?: string;
638
- error: PincodeErrorSchemaResponse;
639
- lat_long?: PincodeLatLongData;
640
- meta?: PincodeMetaResponse;
641
- meta_code?: CountryMetaResponse;
817
+ /** @returns {Localities} */
818
+ declare function Localities(): Localities;
819
+ type Localities = {
820
+ id?: string;
642
821
  name?: string;
643
- parents?: PincodeParentsResponse[];
644
- sub_type?: string;
645
- uid?: string;
646
- };
647
- /** @returns {PincodeErrorSchemaResponse} */
648
- declare function PincodeErrorSchemaResponse(): PincodeErrorSchemaResponse;
649
- type PincodeErrorSchemaResponse = {
650
- message?: string;
822
+ display_name?: string;
823
+ parent_ids?: string[];
651
824
  type?: string;
652
- value?: string;
653
825
  };
654
- /** @returns {PincodeLatLongData} */
655
- declare function PincodeLatLongData(): PincodeLatLongData;
656
- type PincodeLatLongData = {
657
- coordinates?: string[];
826
+ /** @returns {LocalityParent} */
827
+ declare function LocalityParent(): LocalityParent;
828
+ type LocalityParent = {
829
+ id?: string;
830
+ name?: string;
831
+ display_name?: string;
832
+ parent_ids?: string[];
658
833
  type?: string;
659
834
  };
660
- /** @returns {PincodeMetaResponse} */
661
- declare function PincodeMetaResponse(): PincodeMetaResponse;
662
- type PincodeMetaResponse = {
663
- internal_zone_id?: number;
664
- zone?: string;
835
+ /** @returns {GetLocalities} */
836
+ declare function GetLocalities(): GetLocalities;
837
+ type GetLocalities = {
838
+ items?: Localities[];
839
+ page?: Page;
665
840
  };
666
- /** @returns {PincodeParentsResponse} */
667
- declare function PincodeParentsResponse(): PincodeParentsResponse;
668
- type PincodeParentsResponse = {
669
- display_name?: string;
841
+ /** @returns {GetLocality} */
842
+ declare function GetLocality(): GetLocality;
843
+ type GetLocality = {
844
+ id?: string;
670
845
  name?: string;
671
- sub_type?: string;
672
- uid?: string;
673
- };
674
- /** @returns {ReAssignStoreRequest} */
675
- declare function ReAssignStoreRequest(): ReAssignStoreRequest;
676
- type ReAssignStoreRequest = {
677
- articles: any[];
678
- configuration: any;
679
- identifier: string;
680
- ignored_locations: number[];
681
- to_pincode: string;
682
- };
683
- /** @returns {ReAssignStoreResponse} */
684
- declare function ReAssignStoreResponse(): ReAssignStoreResponse;
685
- type ReAssignStoreResponse = {
686
- assigned_stores?: any[];
687
- error: any;
688
- pystormbreaker_uuid: string;
689
- success: boolean;
690
- to_pincode: string;
691
- };
692
- /** @returns {StoreItemResponse} */
693
- declare function StoreItemResponse(): StoreItemResponse;
694
- type StoreItemResponse = {
695
- company_id?: number;
696
- fulfillment_type?: string;
697
- id?: number;
698
- latitude?: number;
699
- longitude?: number;
700
- processing_time?: number;
701
- store_type?: string;
702
- tags?: string[];
703
- };
704
- /** @returns {TATArticlesRequest} */
705
- declare function TATArticlesRequest(): TATArticlesRequest;
706
- type TATArticlesRequest = {
707
- category?: TATCategoryRequest;
708
- manufacturing_time?: number;
709
- manufacturing_time_unit?: string;
710
- };
711
- /** @returns {TATArticlesResponse} */
712
- declare function TATArticlesResponse(): TATArticlesResponse;
713
- type TATArticlesResponse = {
714
- _manufacturing_time_seconds?: number;
715
- category?: TATCategoryRequest;
716
- error?: TATErrorSchemaResponse;
717
- is_cod_available?: boolean;
718
- manufacturing_time?: number;
719
- manufacturing_time_unit?: string;
720
- promise?: TATPromiseResponse;
721
- };
722
- /** @returns {TATCategoryRequest} */
723
- declare function TATCategoryRequest(): TATCategoryRequest;
724
- type TATCategoryRequest = {
725
- id?: number;
726
- level?: string;
727
- };
728
- /** @returns {TATErrorSchemaResponse} */
729
- declare function TATErrorSchemaResponse(): TATErrorSchemaResponse;
730
- type TATErrorSchemaResponse = {
731
- message?: string;
846
+ display_name?: string;
847
+ parent_ids?: string[];
732
848
  type?: string;
733
- value?: string;
734
- };
735
- /** @returns {TATFormattedResponse} */
736
- declare function TATFormattedResponse(): TATFormattedResponse;
737
- type TATFormattedResponse = {
738
- max?: string;
739
- min?: string;
740
- };
741
- /** @returns {TATLocationDetailsRequest} */
742
- declare function TATLocationDetailsRequest(): TATLocationDetailsRequest;
743
- type TATLocationDetailsRequest = {
744
- articles?: TATArticlesRequest[];
745
- from_pincode?: string;
746
- fulfillment_id?: number;
747
- };
748
- /** @returns {TATLocationDetailsResponse} */
749
- declare function TATLocationDetailsResponse(): TATLocationDetailsResponse;
750
- type TATLocationDetailsResponse = {
751
- articles?: TATArticlesResponse[];
752
- from_pincode?: string;
753
- fulfillment_id?: number;
754
- };
755
- /** @returns {TATPromiseResponse} */
756
- declare function TATPromiseResponse(): TATPromiseResponse;
757
- type TATPromiseResponse = {
758
- formatted?: TATFormattedResponse;
759
- timestamp?: TATTimestampResponse;
760
- };
761
- /** @returns {TATTimestampResponse} */
762
- declare function TATTimestampResponse(): TATTimestampResponse;
763
- type TATTimestampResponse = {
764
- max?: number;
765
- min?: number;
766
- };
767
- /** @returns {TATViewRequest} */
768
- declare function TATViewRequest(): TATViewRequest;
769
- type TATViewRequest = {
770
- action?: string;
771
- identifier?: string;
772
- journey?: string;
773
- location_details?: TATLocationDetailsRequest[];
774
- source?: string;
775
- to_pincode?: string;
776
- };
777
- /** @returns {TATViewResponse} */
778
- declare function TATViewResponse(): TATViewResponse;
779
- type TATViewResponse = {
780
- action?: string;
781
- error?: TATErrorSchemaResponse;
782
- identifier?: string;
783
- is_cod_available?: boolean;
784
- journey?: string;
785
- location_details?: TATLocationDetailsResponse[];
786
- payment_mode?: string;
787
- request_uuid?: string;
788
- source?: string;
789
- stormbreaker_uuid?: string;
790
- success?: boolean;
791
- to_city?: string;
792
- to_pincode?: string;
849
+ localities?: LocalityParent[];
793
850
  };
794
- /** @returns {ValidateAddressRequest} */
795
- declare function ValidateAddressRequest(): ValidateAddressRequest;
796
- type ValidateAddressRequest = {
797
- /**
798
- * - A string representing the complete address,
799
- * combining address line 1, address line 2, area, landmark, sector, city,
800
- * state, and pincode. This provides a comprehensive view of the address details.
801
- */
802
- address?: string;
803
- /**
804
- * - A string representing the first line of the
805
- * address, typically containing street or building information.
806
- */
807
- address1?: string;
808
- /**
809
- * - A string representing the second line of the
810
- * address, which can be used for additional address details if needed.
811
- */
812
- address2?: string;
813
- /**
814
- * - A string specifying the locality or area
815
- * associated with the address.
816
- */
817
- area?: string;
818
- /**
819
- * - A string denoting the city or municipality of the address.
820
- */
821
- city?: string;
822
- /**
823
- * - A string containing the recipient's email address.
824
- */
825
- email?: string;
826
- /**
827
- * - A string representing a prominent nearby
828
- * landmark that aids in locating the address.
829
- */
830
- landmark?: string;
831
- /**
832
- * - A string representing the recipient's name or the
833
- * organization name associated with the address.
834
- */
835
- name?: string;
836
- /**
837
- * - An integer representing the recipient's contact
838
- * phone number.
839
- */
840
- phone?: string;
841
- /**
842
- * - A string indicating the postal code or PIN
843
- * code of the address area.
844
- */
845
- pincode?: string;
846
- /**
847
- * - A string specifying the sector or district of
848
- * the address if applicable.
849
- */
850
- sector?: string;
851
- /**
852
- * - A string indicating the state or province of the address.
853
- */
854
- state?: string;
851
+ /** @returns {ErrorResponse} */
852
+ declare function ErrorResponse(): ErrorResponse;
853
+ type ErrorResponse = {
854
+ error?: string;
855
855
  };