@gofynd/fdk-client-javascript 1.6.3 → 2.0.0

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 (146) hide show
  1. package/README.md +1 -1
  2. package/package.json +1 -1
  3. package/sdk/application/Cart/CartApplicationClient.d.ts +5 -5
  4. package/sdk/application/Cart/CartApplicationClient.js +26 -268
  5. package/sdk/application/Catalog/CatalogApplicationClient.d.ts +20 -20
  6. package/sdk/application/Catalog/CatalogApplicationClient.js +98 -347
  7. package/sdk/application/Common/CommonApplicationClient.js +1 -16
  8. package/sdk/application/Communication/CommunicationApplicationClient.js +1 -24
  9. package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +24 -2
  10. package/sdk/application/Configuration/ConfigurationApplicationClient.js +58 -137
  11. package/sdk/application/Content/ContentApplicationClient.d.ts +47 -7
  12. package/sdk/application/Content/ContentApplicationClient.js +222 -191
  13. package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +2 -2
  14. package/sdk/application/FileStorage/FileStorageApplicationClient.js +11 -30
  15. package/sdk/application/Finance/FinanceApplicationClient.js +1 -16
  16. package/sdk/application/Lead/LeadApplicationClient.d.ts +4 -4
  17. package/sdk/application/Lead/LeadApplicationClient.js +21 -52
  18. package/sdk/application/Logistic/LogisticApplicationClient.d.ts +16 -56
  19. package/sdk/application/Logistic/LogisticApplicationClient.js +57 -332
  20. package/sdk/application/Order/OrderApplicationClient.d.ts +11 -11
  21. package/sdk/application/Order/OrderApplicationClient.js +68 -153
  22. package/sdk/application/Payment/PaymentApplicationClient.d.ts +2 -12
  23. package/sdk/application/Payment/PaymentApplicationClient.js +7 -487
  24. package/sdk/application/Rewards/RewardsApplicationClient.d.ts +1 -1
  25. package/sdk/application/Rewards/RewardsApplicationClient.js +6 -59
  26. package/sdk/application/Share/ShareApplicationClient.d.ts +4 -4
  27. package/sdk/application/Share/ShareApplicationClient.js +21 -75
  28. package/sdk/application/Theme/ThemeApplicationClient.d.ts +3 -3
  29. package/sdk/application/Theme/ThemeApplicationClient.js +19 -47
  30. package/sdk/application/User/UserApplicationClient.js +1 -407
  31. package/sdk/application/Webhook/WebhookApplicationClient.js +1 -8
  32. package/sdk/common/Utility.d.ts +1 -1
  33. package/sdk/common/Utility.js +4 -4
  34. package/sdk/common/Validator.d.ts +1 -0
  35. package/sdk/common/Validator.js +20 -0
  36. package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +1 -55
  37. package/sdk/partner/FileStorage/FileStoragePartnerClient.js +1 -408
  38. package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +0 -5
  39. package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +0 -37
  40. package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -0
  41. package/sdk/partner/Lead/LeadPartnerModel.js +2 -0
  42. package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +29 -25
  43. package/sdk/partner/Logistics/LogisticsPartnerClient.js +65 -42
  44. package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1008 -794
  45. package/sdk/partner/Logistics/LogisticsPartnerModel.js +573 -460
  46. package/sdk/partner/Logistics/LogisticsPartnerValidator.js +10 -5
  47. package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +64 -1
  48. package/sdk/partner/Webhook/WebhookPartnerModel.js +36 -0
  49. package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +5 -0
  50. package/sdk/platform/Analytics/AnalyticsPlatformModel.js +2 -0
  51. package/sdk/platform/Cart/CartPlatformModel.d.ts +67 -9
  52. package/sdk/platform/Cart/CartPlatformModel.js +38 -5
  53. package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1 -1
  54. package/sdk/platform/Catalog/CatalogPlatformClient.js +4 -4
  55. package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +47 -13
  56. package/sdk/platform/Catalog/CatalogPlatformModel.js +29 -7
  57. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +2 -2
  58. package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +7 -4
  59. package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +71 -7
  60. package/sdk/platform/Communication/CommunicationPlatformModel.js +70 -6
  61. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +0 -27
  62. package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +8 -60
  63. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +31 -20
  64. package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +18 -18
  65. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +1 -1
  66. package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +3 -3
  67. package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +13 -0
  68. package/sdk/platform/Configuration/ConfigurationPlatformClient.js +30 -1
  69. package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +68 -11
  70. package/sdk/platform/Configuration/ConfigurationPlatformModel.js +49 -7
  71. package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +169 -0
  72. package/sdk/platform/Content/ContentPlatformApplicationClient.js +1279 -132
  73. package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +156 -1
  74. package/sdk/platform/Content/ContentPlatformApplicationValidator.js +180 -0
  75. package/sdk/platform/Content/ContentPlatformClient.d.ts +162 -0
  76. package/sdk/platform/Content/ContentPlatformClient.js +1697 -497
  77. package/sdk/platform/Content/ContentPlatformModel.d.ts +1053 -35
  78. package/sdk/platform/Content/ContentPlatformModel.js +717 -34
  79. package/sdk/platform/Content/ContentPlatformValidator.d.ts +127 -1
  80. package/sdk/platform/Content/ContentPlatformValidator.js +171 -0
  81. package/sdk/platform/Discount/DiscountPlatformClient.d.ts +34 -0
  82. package/sdk/platform/Discount/DiscountPlatformClient.js +59 -0
  83. package/sdk/platform/Discount/DiscountPlatformModel.d.ts +365 -93
  84. package/sdk/platform/Discount/DiscountPlatformModel.js +98 -93
  85. package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +54 -34
  86. package/sdk/platform/Discount/DiscountPlatformValidator.js +27 -17
  87. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +0 -156
  88. package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +0 -1072
  89. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -137
  90. package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +0 -173
  91. package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +1 -1105
  92. package/sdk/platform/FileStorage/FileStoragePlatformModel.js +0 -1125
  93. package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -0
  94. package/sdk/platform/Lead/LeadPlatformModel.js +2 -0
  95. package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +0 -10
  96. package/sdk/platform/Order/OrderPlatformApplicationClient.js +0 -92
  97. package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +1 -28
  98. package/sdk/platform/Order/OrderPlatformApplicationValidator.js +0 -18
  99. package/sdk/platform/Order/OrderPlatformClient.d.ts +212 -0
  100. package/sdk/platform/Order/OrderPlatformClient.js +397 -0
  101. package/sdk/platform/Order/OrderPlatformModel.d.ts +66 -10
  102. package/sdk/platform/Order/OrderPlatformModel.js +39 -7
  103. package/sdk/platform/Order/OrderPlatformValidator.d.ts +33 -1
  104. package/sdk/platform/Order/OrderPlatformValidator.js +20 -0
  105. package/sdk/platform/Partner/PartnerPlatformModel.d.ts +58 -10
  106. package/sdk/platform/Partner/PartnerPlatformModel.js +19 -10
  107. package/sdk/platform/Payment/PaymentPlatformModel.d.ts +12 -2
  108. package/sdk/platform/Payment/PaymentPlatformModel.js +8 -2
  109. package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +5 -0
  110. package/sdk/platform/Rewards/RewardsPlatformModel.js +2 -0
  111. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +240 -24
  112. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +1753 -277
  113. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +320 -22
  114. package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +269 -19
  115. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +53 -104
  116. package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +201 -629
  117. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +5720 -2891
  118. package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +3414 -2181
  119. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +138 -216
  120. package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +81 -148
  121. package/sdk/platform/Share/SharePlatformModel.d.ts +5 -0
  122. package/sdk/platform/Share/SharePlatformModel.js +2 -0
  123. package/sdk/platform/User/UserPlatformApplicationClient.d.ts +73 -0
  124. package/sdk/platform/User/UserPlatformApplicationClient.js +543 -0
  125. package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +129 -1
  126. package/sdk/platform/User/UserPlatformApplicationValidator.js +97 -0
  127. package/sdk/platform/User/UserPlatformModel.d.ts +269 -6
  128. package/sdk/platform/User/UserPlatformModel.js +187 -5
  129. package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +64 -1
  130. package/sdk/platform/Webhook/WebhookPlatformModel.js +36 -0
  131. package/sdk/public/Catalog/CatalogPublicClient.d.ts +1 -1
  132. package/sdk/public/Catalog/CatalogPublicClient.js +6 -11
  133. package/sdk/public/Configuration/ConfigurationPublicClient.js +1 -16
  134. package/sdk/public/Content/ContentPublicClient.d.ts +36 -3
  135. package/sdk/public/Content/ContentPublicClient.js +261 -104
  136. package/sdk/public/Content/ContentPublicModel.d.ts +155 -1
  137. package/sdk/public/Content/ContentPublicModel.js +102 -0
  138. package/sdk/public/Content/ContentPublicValidator.d.ts +18 -1
  139. package/sdk/public/Content/ContentPublicValidator.js +26 -0
  140. package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
  141. package/sdk/public/Partner/PartnerPublicClient.js +6 -11
  142. package/sdk/public/Partner/PartnerPublicModel.d.ts +248 -72
  143. package/sdk/public/Partner/PartnerPublicModel.js +81 -71
  144. package/sdk/public/Partner/PartnerPublicValidator.d.ts +2 -2
  145. package/sdk/public/Partner/PartnerPublicValidator.js +1 -1
  146. package/sdk/public/Webhook/WebhookPublicClient.js +1 -40
@@ -1,10 +1,42 @@
1
1
  export = LogisticsPartnerModel;
2
+ /**
3
+ * @typedef CourierPartnerSchemeModelSchema
4
+ * @property {CreatedBy} [created_by]
5
+ * @property {string} [created_on] - The timestamp when the record was created.
6
+ * @property {ModifiedBy} [modified_by]
7
+ * @property {string} [modified_on] - The timestamp when the record last modified.
8
+ * @property {string} [extension_id] - Unique identifier of courier partner extension.
9
+ * @property {string} [scheme_id] - Unique identifier for the scheme, used to
10
+ * fetch or modify scheme details.
11
+ * @property {string} [company_id] - Unique identifier of company.
12
+ * @property {string} name - Name of the scheme.
13
+ * @property {ArithmeticOperations} weight
14
+ * @property {ArithmeticOperations} [volumetric_weight]
15
+ * @property {string} transport_type - Mode of transport associated with the
16
+ * courier partner scheme.
17
+ * @property {string} region - Serviceable region associated with the courier
18
+ * partner scheme.
19
+ * @property {string} delivery_type - Type of delivery associated with the
20
+ * courier partner scheme.
21
+ * @property {string[]} payment_mode - Mode of payment associated with the
22
+ * courier partner scheme.
23
+ * @property {string} stage - Indicates if the courier partner scheme is
24
+ * currently active or inactive.
25
+ * @property {string} [status_updates] - Describes the type of status updates
26
+ * provided by the courier partner (e.g., real-time, periodic).
27
+ * @property {number} [ndr_attempts] - Indicates if the Non-Delivery Report
28
+ * (NDR) feature is supported by the courier partner.
29
+ * @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
30
+ * of items allowed in a quality check shipment.
31
+ * @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
32
+ * quantity of items allowed in a non-quality check shipment.
33
+ * @property {CourierPartnerSchemeFeatures} feature
34
+ */
2
35
  /**
3
36
  * @typedef BulkRegionServiceabilityTatDetails
4
- * @property {string} country - Name of the country.
5
- * @property {string} region - Name of the region for which the
6
- * tat/serviceability file needs to be downloaded.
7
- * @property {string} type - Denotes the type of file.
37
+ * @property {string} country - Country involved in the operation.
38
+ * @property {string} region - Region involved in the operation.
39
+ * @property {string} type - Type of operation, either serviceability or TAT.
8
40
  */
9
41
  /**
10
42
  * @typedef BulkRegionServiceabilityTatResultItemData
@@ -12,77 +44,84 @@ export = LogisticsPartnerModel;
12
44
  * @property {string} [region] - Name of the region for which the
13
45
  * tat/serviceability file needs to be downloaded.
14
46
  * @property {string} [type] - Denotes the type of data.
15
- * @property {string} [batch_id] - Unique identifier identifying the perticular request.
47
+ * @property {string} [batch_id] - A unique identifier for the performed batch operation.
16
48
  * @property {string} [status] - Current status of the request.
17
49
  * @property {Object[]} [failed_records] - Information of records which failed
18
50
  * @property {string} [file_path] - CDN path of the file.
19
51
  */
20
52
  /**
21
- * @typedef ErrorResult
22
- * @property {string} value - Fields containing the error.
23
- * @property {string} message - Description of the error.
24
- * @property {string} type - Type of the error.
53
+ * @typedef CommonErrorResult
54
+ * @property {Error[]} [error] - An array of items referencing the ErrorResult
55
+ * schema, which likely contains detailed information about the errors.
56
+ */
57
+ /**
58
+ * @typedef BulkFailureResult
59
+ * @property {boolean} [success] - Whether operation was successful.
60
+ * @property {Error[]} error - An array containing error details.
25
61
  */
26
62
  /**
27
63
  * @typedef FailureResult
28
- * @property {boolean} success - Denotes if the request was successfully executed.
29
- * @property {ErrorResult[]} error
64
+ * @property {boolean} [success] - Whether operation was successful.
65
+ * @property {Error[]} [error] - Array of error details.
30
66
  */
31
67
  /**
32
68
  * @typedef BulkRegionServiceabilityTatResult
33
- * @property {BulkRegionServiceabilityTatResultItemData[]} [items]
69
+ * @property {BulkRegionServiceabilityTatResultItemData[]} [items] - Array of
70
+ * bulk region serviceability or TAT result items.
34
71
  * @property {Page} [page]
35
72
  */
36
- /**
37
- * @typedef Page
38
- * @property {number} [item_total] - The total number of items on the page.
39
- * @property {string} [next_id] - The identifier for the next page.
40
- * @property {boolean} [has_previous] - Indicates whether there is a previous page.
41
- * @property {boolean} [has_next] - Indicates whether there is a next page.
42
- * @property {number} [current] - The current page number.
43
- * @property {string} type - The type of the page, such as 'PageType'.
44
- * @property {number} [size] - The number of items per page.
45
- */
46
- /**
47
- * @typedef CourierAccountUpdateDetails
48
- * @property {string} extension_id - Unique identifier of courier partner extension.
49
- * @property {string} scheme_id - Unique identifier of courier partner scheme.
50
- * @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
51
- * @property {string} stage - Denotes whether the account is in enabled or disabled stage.
52
- * @property {boolean} is_own_account - Denotes whether it is the seller's own
53
- * account or not.
54
- */
55
73
  /**
56
74
  * @typedef RegionTatItemResult
57
- * @property {RegionTatResult[]} items
75
+ * @property {RegionTatResult[]} items - An array that contains items of region tat.
58
76
  * @property {Page} page
59
77
  */
60
78
  /**
61
79
  * @typedef RegionServiceabilityItemResult
62
- * @property {RegionServiceabilityResult[]} items
80
+ * @property {RegionServiceabilityResult[]} items - An array that contains items
81
+ * of region serviceability.
63
82
  * @property {Page} page
64
83
  */
65
84
  /**
66
85
  * @typedef ServiceabilityDetailsResult
86
+ * @property {string} [pickup_cutoff] - Time of day by which pickups must be
87
+ * scheduled to be processed on the same day.
88
+ * @property {string} [country_code] - ISO2 code representing the country where
89
+ * the serviceability is being specified.
90
+ * @property {string} [state_code] - Code representing the state or province
91
+ * within the country where the serviceability is being specified.
92
+ * @property {string} [city_code] - Code representing the city within the state
93
+ * where the serviceability is being specified.
94
+ * @property {string} [sector_code] - Code representing a specific sector or
95
+ * district within the city where the serviceability is being specified.
96
+ * @property {string} [pincode] - A string indicating the postal code or PIN
97
+ * code of the address area.
67
98
  * @property {boolean} [first_mile] - Boolean value indicating whether
68
99
  * first-mile service is available or not.
69
100
  * @property {boolean} [last_mile] - Boolean value indicating whether last-mile
70
101
  * service is available or not.
71
- * @property {boolean} [reverse_pickup] - Boolean value indicating whether a
72
- * region is first-mile serviceable or not in return pickup.
73
102
  * @property {number} [cod_limit] - Limit on the amount of cash on delivery
74
103
  * (COD) payments allowed in the specified region.
104
+ * @property {number} [prepaid_limit] - Limit on the amount of prepaid payments
105
+ * allowed in the specified region.
75
106
  * @property {boolean} [doorstep_return] - Indicates if doorstep return service
76
107
  * is available. This refers to the ability to return items directly from the
77
108
  * customer's doorstep.
78
109
  * @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
79
110
  * service is available. This refers to the ability to perform quality checks
80
111
  * on items at the customer's doorstep.
81
- * @property {string} [pickup_cutoff] - Time of day by which pickups must be
82
- * scheduled to be processed on the same day.
112
+ * @property {string} [forward_pickup_cutoff] - Time of day by which pickups
113
+ * must be scheduled to be processed on the same day in the forward journey.
114
+ * @property {string} [reverse_pickup_cutoff] - Time of day by which pickups
115
+ * must be scheduled to be processed on the same day in the reverse journey.
116
+ * @property {boolean} [hand_to_hand_exchange] - Indicates whether the product
117
+ * exchange happens directly between the buyer and seller (e.g., in person),
118
+ * instead of through a third-party service.
119
+ * @property {string[]} [holiday_list] - List of holidays for a courier partner scheme.
120
+ * @property {boolean} [reverse_pickup] - Boolean value indicating whether
121
+ * reverse pickup services is available.
83
122
  * @property {boolean} [installation] - Boolean value indicating whether
84
123
  * installation services are available in the specified region or not.
85
- * @property {string} [id] - Unique identifier for the serviceability record.
124
+ * @property {string} [id] - A string serving as the unique identifier.
86
125
  */
87
126
  /**
88
127
  * @typedef ServiceabilityDetails
@@ -90,8 +129,6 @@ export = LogisticsPartnerModel;
90
129
  * first-mile service is available or not.
91
130
  * @property {boolean} [last_mile] - Boolean value indicating whether last-mile
92
131
  * service is available or not.
93
- * @property {boolean} [reverse_pickup] - Boolean value indicating whether a
94
- * region is first-mile serviceable or not in return pickup.
95
132
  * @property {number} [cod_limit] - Limit on the amount of cash on delivery
96
133
  * (COD) payments allowed in the specified region.
97
134
  * @property {boolean} [doorstep_return] - Indicates if doorstep return service
@@ -100,13 +137,23 @@ export = LogisticsPartnerModel;
100
137
  * @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
101
138
  * service is available. This refers to the ability to perform quality checks
102
139
  * on items at the customer's doorstep.
103
- * @property {string} [pickup_cutoff] - Time of day by which pickups must be
104
- * scheduled to be processed on the same day.
140
+ * @property {string} [forward_pickup_cutoff] - Time of day by which pickups
141
+ * must be scheduled to be processed on the same day in the forward journey.
142
+ * @property {string} [reverse_pickup_cutoff] - Time of day by which pickups
143
+ * must be scheduled to be processed on the same day in the reverse journey.
144
+ * @property {boolean} [hand_to_hand_exchange] - Indicates whether the product
145
+ * exchange happens directly between the buyer and seller (e.g., in person),
146
+ * instead of through a third-party service.
147
+ * @property {string[]} [holiday_list] - List of holidays for a courier partner scheme.
105
148
  * @property {boolean} [installation] - Boolean value indicating whether
106
149
  * installation services are available in the specified region or not.
150
+ * @property {string} [pickup_cutoff] - Time of day by which pickups must be
151
+ * scheduled to be processed on the same day.
107
152
  */
108
153
  /**
109
154
  * @typedef RegionServiceabilityResult
155
+ * @property {string} [pickup_cutoff] - Time of day by which pickups must be
156
+ * scheduled to be processed on the same day.
110
157
  * @property {string} country_code - ISO2 code representing the country where
111
158
  * the serviceability is being specified.
112
159
  * @property {string} [state_code] - Code representing the state or province
@@ -115,27 +162,34 @@ export = LogisticsPartnerModel;
115
162
  * where the serviceability is being specified.
116
163
  * @property {string} [sector_code] - Code representing a specific sector or
117
164
  * district within the city where the serviceability is being specified.
118
- * @property {string} [pincode] - Postal or ZIP code for the specific area
119
- * within the city where the serviceability is being specified.
165
+ * @property {string} [pincode] - A string indicating the postal code or PIN
166
+ * code of the address area.
120
167
  * @property {boolean} [first_mile] - Boolean value indicating whether
121
168
  * first-mile service is available or not.
122
169
  * @property {boolean} [last_mile] - Boolean value indicating whether last-mile
123
170
  * service is available or not.
124
- * @property {boolean} [reverse_pickup] - Boolean value indicating whether a
125
- * region is first-mile serviceable or not in return pickup.
126
171
  * @property {number} [cod_limit] - Limit on the amount of cash on delivery
127
172
  * (COD) payments allowed in the specified region.
173
+ * @property {number} [prepaid_limit] - Limit on the amount of prepaid payments
174
+ * allowed in the specified region.
128
175
  * @property {boolean} [doorstep_return] - Indicates if doorstep return service
129
176
  * is available. This refers to the ability to return items directly from the
130
177
  * customer's doorstep.
131
178
  * @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
132
179
  * service is available. This refers to the ability to perform quality checks
133
180
  * on items at the customer's doorstep.
134
- * @property {string} [pickup_cutoff] - Time of day by which pickups must be
135
- * scheduled to be processed on the same day.
181
+ * @property {boolean} [reverse_pickup] - Indicates if reverse pickup is available.
182
+ * @property {string} [forward_pickup_cutoff] - Time of day by which pickups
183
+ * must be scheduled to be processed on the same day in the forward journey.
184
+ * @property {string} [reverse_pickup_cutoff] - Time of day by which pickups
185
+ * must be scheduled to be processed on the same day in the reverse journey.
186
+ * @property {boolean} [hand_to_hand_exchange] - Indicates whether the product
187
+ * exchange happens directly between the buyer and seller (e.g., in person),
188
+ * instead of through a third-party service.
189
+ * @property {string[]} [holiday_list] - List of holidays for a courier partner scheme.
136
190
  * @property {boolean} [installation] - Boolean value indicating whether
137
191
  * installation services are available in the specified region or not.
138
- * @property {string} id - Unique identifier for the serviceability record.
192
+ * @property {string} id - A string serving as the unique identifier.
139
193
  */
140
194
  /**
141
195
  * @typedef RegionServiceabilityDetails
@@ -147,14 +201,12 @@ export = LogisticsPartnerModel;
147
201
  * where the serviceability is being specified.
148
202
  * @property {string} [sector_code] - Code representing a specific sector or
149
203
  * district within the city where the serviceability is being specified.
150
- * @property {string} [pincode] - Postal or ZIP code for the specific area
151
- * within the city where the serviceability is being specified.
204
+ * @property {string} [pincode] - A string indicating the postal code or PIN
205
+ * code of the address area.
152
206
  * @property {boolean} [first_mile] - Boolean value indicating whether
153
207
  * first-mile service is available or not.
154
208
  * @property {boolean} [last_mile] - Boolean value indicating whether last-mile
155
209
  * service is available or not.
156
- * @property {boolean} [reverse_pickup] - Boolean value indicating whether a
157
- * region is first-mile serviceable or not in return pickup.
158
210
  * @property {number} [cod_limit] - Limit on the amount of cash on delivery
159
211
  * (COD) payments allowed in the specified region.
160
212
  * @property {boolean} [doorstep_return] - Indicates if doorstep return service
@@ -163,13 +215,27 @@ export = LogisticsPartnerModel;
163
215
  * @property {boolean} [doorstep_qc] - Indicates if doorstep quality check
164
216
  * service is available. This refers to the ability to perform quality checks
165
217
  * on items at the customer's doorstep.
218
+ * @property {string} [forward_pickup_cutoff] - Time of day by which pickups
219
+ * must be scheduled to be processed on the same day in the forward journey.
166
220
  * @property {string} [pickup_cutoff] - Time of day by which pickups must be
167
221
  * scheduled to be processed on the same day.
222
+ * @property {string} [reverse_pickup_cutoff] - Time of day by which pickups
223
+ * must be scheduled to be processed on the same day in the reverse journey.
224
+ * @property {boolean} [hand_to_hand_exchange] - Indicates whether the product
225
+ * exchange happens directly between the buyer and seller (e.g., in person),
226
+ * instead of through a third-party service.
227
+ * @property {number} [prepaid_limit] - Limit on the amount of prepaid payments
228
+ * allowed in the specified region.
229
+ * @property {string[]} [holiday_list] - List of holidays for a courier partner scheme.
168
230
  * @property {boolean} [installation] - Boolean value indicating whether
169
231
  * installation services are available in the specified region or not.
170
232
  */
171
233
  /**
172
234
  * @typedef RegionTatDetails
235
+ * @property {number} [max_delivery_time] - Maximum time required for delivery
236
+ * from the origin to the destination in seconds.
237
+ * @property {number} [min_delivery_time] - Minimum time required for delivery
238
+ * from the origin to the destination in seconds.
173
239
  * @property {string} from_country_code - ISO2 code representing the country of
174
240
  * origin for the delivery.
175
241
  * @property {string} [from_state_code] - Code representing the state or
@@ -178,7 +244,8 @@ export = LogisticsPartnerModel;
178
244
  * within the state.
179
245
  * @property {string} [from_sector_code] - Code representing a specific sector
180
246
  * or district within the city of origin.
181
- * @property {string} [from_pincode] - Postal or ZIP code of the origin area.
247
+ * @property {string} [from_pincode] - A string indicating the postal code or
248
+ * PIN code of the address area.
182
249
  * @property {string} to_country_code - ISO2 code representing the destination country.
183
250
  * @property {string} [to_state_code] - Code representing the state or province
184
251
  * of the destination within the country.
@@ -186,21 +253,17 @@ export = LogisticsPartnerModel;
186
253
  * within the state.
187
254
  * @property {string} [to_sector_code] - Code representing a specific sector or
188
255
  * district within the city of destination.
189
- * @property {string} [to_pincode] - Postal or ZIP code of the destination area.
190
- * @property {number} [max_delivery_time] - Maximum time required for delivery
191
- * from the origin to the destination in seconds.
192
- * @property {number} [min_delivery_time] - Minimum time required for delivery
193
- * from the origin to the destination in seconds.
256
+ * @property {string} [to_pincode] - A string indicating the postal code or PIN
257
+ * code of the address area.
258
+ * @property {TATDetails} [forward]
259
+ * @property {TATDetails} [reverse]
194
260
  */
195
261
  /**
196
- * @typedef RegionTatUpdateDetails
197
- * @property {number} [max_delivery_time] - Maximum time required for delivery
198
- * from the origin to the destination in seconds.
262
+ * @typedef RegionTatResult
199
263
  * @property {number} [min_delivery_time] - Minimum time required for delivery
200
264
  * from the origin to the destination in seconds.
201
- */
202
- /**
203
- * @typedef RegionTatResult
265
+ * @property {number} [max_delivery_time] - Maximum time required for delivery
266
+ * from the origin to the destination in seconds.
204
267
  * @property {string} from_country_code - ISO2 code representing the country of
205
268
  * origin for the delivery.
206
269
  * @property {string} [from_state_code] - Code representing the state or
@@ -209,7 +272,8 @@ export = LogisticsPartnerModel;
209
272
  * within the state.
210
273
  * @property {string} [from_sector_code] - Code representing a specific sector
211
274
  * or district within the city of origin.
212
- * @property {string} [from_pincode] - Postal or ZIP code of the origin area.
275
+ * @property {string} [from_pincode] - A string indicating the postal code or
276
+ * PIN code of the address area.
213
277
  * @property {string} to_country_code - ISO2 code representing the destination country.
214
278
  * @property {string} [to_state_code] - Code representing the state or province
215
279
  * of the destination within the country.
@@ -217,209 +281,81 @@ export = LogisticsPartnerModel;
217
281
  * within the state.
218
282
  * @property {string} [to_sector_code] - Code representing a specific sector or
219
283
  * district within the city of destination.
220
- * @property {string} [to_pincode] - Postal or ZIP code of the destination area.
221
- * @property {number} [max_delivery_time] - Maximum time required for delivery
222
- * from the origin to the destination in seconds.
223
- * @property {number} [min_delivery_time] - Minimum time required for delivery
224
- * from the origin to the destination in seconds.
225
- * @property {string} id - Unique identifier for the delivery time record.
284
+ * @property {string} [to_pincode] - A string indicating the postal code or PIN
285
+ * code of the address area.
286
+ * @property {TATDetails} [forward]
287
+ * @property {TATDetails} [reverse]
288
+ * @property {string} id - A string serving as the unique identifier.
226
289
  */
227
290
  /**
228
291
  * @typedef BulkRegionJobDetails
229
- * @property {string} [file_path] - CDN path of the uploaded csv file for bulk import.
230
- * @property {string} country - Country for which the tat or serviceability is
231
- * to be imported or exported.
232
- * @property {string} action - Denotes the import or export action to be performed.
233
- * @property {string} region - Region of the country for which import or export
234
- * is triggered.
292
+ * @property {string} [file_path] - Path to the file used in the bulk operation.
293
+ * @property {string} country - Country involved in the bulk operation.
294
+ * @property {string} action - Action type for the bulk operation, either import
295
+ * or export.
296
+ * @property {string} region - Region involved in the bulk operation.
235
297
  */
236
298
  /**
237
299
  * @typedef BulkRegionResultItemData
238
- * @property {string} [file_path] - CDN path of the file which was used for bulk import.
239
- * @property {number} [failed] - Count of the failed records.
240
- * @property {Object[]} [failed_records] - Information of records which failed.
241
- * @property {string} action - Denotes the import or export action performed.
242
- * @property {string} batch_id - Unique id to identify the import or export query.
243
- * @property {string} country - Country for which the import or export action is
244
- * performed.
245
- * @property {number} [success] - Denoted if the import or export was successful
246
- * or failure.
247
- * @property {string} region - Region of the country for which import or export
248
- * is triggered.
249
- * @property {string} status - Current status of the import or export action performed.
250
- * @property {number} [total] - Count of total records.
251
- * @property {string} [error_file_path] - Path of the error file.
300
+ * @property {string} file_path - Path to the file associated with the result item.
301
+ * @property {number} [failed] - Number of failed records in the operation.
302
+ * @property {Object[]} [failed_records] - Array of failed records with
303
+ * additional properties.
304
+ * @property {string} action - Action type for the result item.
305
+ * @property {string} batch_id - A unique identifier for the performed batch operation.
306
+ * @property {string} country - Country associated with the result item.
307
+ * @property {number} [success] - Number of successful records in the operation.
308
+ * @property {string} region - Region associated with the result item.
309
+ * @property {string} status - Current status of the result item.
310
+ * @property {number} [total] - Total number of records processed.
311
+ * @property {string} [error_file_path] - Path to the file containing error details.
252
312
  */
253
313
  /**
254
314
  * @typedef BulkRegionResult
255
- * @property {BulkRegionResultItemData[]} items
315
+ * @property {BulkRegionResultItemData[]} items - Array of bulk region result items.
256
316
  * @property {Page} page
257
317
  */
258
- /**
259
- * @typedef CourierAccount
260
- * @property {string} extension_id - Unique identifier of courier partner extension.
261
- * @property {string} account_id - Unique identifier of courier partner scheme
262
- * and company id combination.
263
- * @property {string} scheme_id - Unique identifier of courier partner scheme.
264
- * @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
265
- * @property {string} stage - Denotes whether the account is in enabled or disabled stage.
266
- * @property {boolean} is_own_account - Denotes whether it is the seller's own
267
- * account or not.
268
- */
269
318
  /**
270
319
  * @typedef CourierAccountDetailsBody
271
- * @property {string} extension_id - Unique identifier of courier partner extension.
272
- * @property {string} [account_id] - Unique identifier of courier partner scheme
273
- * and company id combination.
274
- * @property {string} scheme_id - Unique identifier of courier account.
275
- * @property {boolean} is_self_ship - Denotes if the account is of self delivery type.
276
- * @property {string} stage - Denotes whether the courier account is in enabled
277
- * or disabled stage.
278
- * @property {boolean} is_own_account - Denotes whether it is the seller's own
279
- * account or not.
280
- */
281
- /**
282
- * @typedef CourierPartnerAccountFailureResult
283
- * @property {boolean} success
284
- * @property {ErrorResult[]} error
320
+ * @property {string} extension_id - The unique identifier for the extension
321
+ * linked to the courier account.
322
+ * @property {string} [account_id] - The unique identifier for the courier account.
323
+ * @property {string} scheme_id - The identifier for the scheme associated with
324
+ * the courier account.
325
+ * @property {boolean} is_self_ship - Indicates whether the courier account
326
+ * supports self-shipping (true if it does, false otherwise).
327
+ * @property {string} stage - The current stage of the courier account, either
328
+ * 'enabled' or 'disabled'.
329
+ * @property {boolean} is_own_account - Indicates whether the courier account is
330
+ * an own account (true if it is, false otherwise).
285
331
  */
286
332
  /**
287
333
  * @typedef CompanyCourierPartnerAccountListResult
288
- * @property {CourierAccountResult[]} items
334
+ * @property {CourierAccountResult[]} items - An array containing multiple
335
+ * instances of CourierAccountResult, which details individual courier accounts.
289
336
  * @property {Page} page
290
337
  */
291
338
  /**
292
339
  * @typedef CourierAccountResult
293
- * @property {string} account_id - Unique identifier of courier partner scheme
294
- * and company id combination.
295
- * @property {string} scheme_id - Unique identifier of courier partner scheme.
296
- * @property {boolean} is_self_ship
297
- * @property {string} stage - Denotes whether the courier account is in enabled
298
- * or disabled stage.
299
- * @property {boolean} is_own_account - Denotes whether it is the seller's own
300
- * account or not.
340
+ * @property {string} account_id - A string that uniquely identifies the courier account.
341
+ * @property {number} [company_id] - The unique identifier of the company.
342
+ * @property {string} scheme_id - A string that specifies the unique identifier
343
+ * for the scheme associated with the account
344
+ * @property {string} [extension_id] - A string that uniquely identifies the
345
+ * courier partner extension.
346
+ * @property {boolean} is_self_ship - A boolean indicating whether the account
347
+ * is for self-shipping.
348
+ * @property {string} stage - A string indicating the current stage of the
349
+ * account, which can be either enabled or disabled.
350
+ * @property {boolean} is_own_account - A boolean indicating whether the account
351
+ * is owned by the company.
301
352
  * @property {CourierPartnerSchemeModel} scheme_rules
302
353
  */
303
- /**
304
- * @typedef CourierPartnerSchemeModel
305
- * @property {string} extension_id - Unique identifier of courier partner extension.
306
- * @property {string} scheme_id - Unique identifier of courier partner scheme.
307
- * @property {string} name - Name of the scheme
308
- * @property {ArithmeticOperations} weight
309
- * @property {string} transport_type - Mode of transport associated with the
310
- * courier partner scheme.
311
- * @property {string} region - Serviceable region associated with the courier
312
- * partner scheme.
313
- * @property {string} delivery_type - Type of delivery associated with the
314
- * courier partner scheme.
315
- * @property {string[]} payment_mode - Mode of payment associated with the
316
- * courier partner scheme.
317
- * @property {string} stage - Indicates if the courier partner scheme is
318
- * currently active or inactive.
319
- * @property {CourierPartnerSchemeFeatures} feature
320
- */
321
354
  /**
322
355
  * @typedef CourierPartnerSchemeDetailsModel
323
356
  * @property {string} extension_id - Unique identifier of courier partner extension.
324
- * @property {string} [scheme_id] - Unique identifier of courier partner scheme.
325
- * @property {string} name - Name of the courier partner scheme.
326
- * @property {ArithmeticOperations} weight
327
- * @property {string} transport_type - Mode of transport associated with the
328
- * courier partner scheme.
329
- * @property {string} region - Serviceable region associated with the courier
330
- * partner scheme.
331
- * @property {string} delivery_type - Type of delivery associated with the
332
- * courier partner scheme.
333
- * @property {string[]} payment_mode - Mode of payment associated with the
334
- * courier partner scheme.
335
- * @property {string} stage - Indicates if the courier partner scheme is
336
- * currently active or inactive.
337
- * @property {CourierPartnerSchemeFeatures} feature
338
- */
339
- /**
340
- * @typedef CourierPartnerSchemeFeatures
341
- * @property {boolean} [doorstep_qc] - Indicates if the courier partner offers
342
- * doorstep quality check services.
343
- * @property {boolean} [qr] - Specifies whether the courier partner supports QR
344
- * code-based operations.
345
- * @property {boolean} [mps] - Denotes if the courier partner supports
346
- * multi-part shipment services.
347
- * @property {boolean} [ndr] - Indicates if the Non-Delivery Report (NDR)
348
- * feature is supported by the courier partner.
349
- * @property {number} [ndr_attempts] - Number of attempts allowed for resolving
350
- * Non-Delivery Reports (NDR).
351
- * @property {boolean} [dangerous_goods] - Specifies if the courier partner
352
- * handles the transportation of dangerous goods.
353
- * @property {boolean} [fragile_goods] - Indicates whether the courier partner
354
- * manages the shipment of fragile goods.
355
- * @property {boolean} [restricted_goods] - Indicates if the courier partner
356
- * handles restricted goods, as per regulatory guidelines.
357
- * @property {boolean} [cold_storage_goods] - Denotes if the courier partner
358
- * provides cold storage facilities for goods.
359
- * @property {boolean} [doorstep_exchange] - Indicates if the courier partner
360
- * supports doorstep exchange services.
361
- * @property {boolean} [doorstep_return] - Specifies if the courier partner
362
- * offers doorstep return services.
363
- * @property {boolean} [product_installation] - Indicates if the courier partner
364
- * provides product installation services upon delivery.
365
- * @property {boolean} [openbox_delivery] - Specifies whether the courier
366
- * partner supports open-box delivery, allowing customers to inspect goods
367
- * before accepting.
368
- * @property {string} [status_updates] - Describes the type of status updates
369
- * provided by the courier partner (e.g., real-time, periodic).
370
- * @property {boolean} [multi_pick_single_drop] - Indicates if the courier
371
- * partner supports multiple pickups to a single drop location.
372
- * @property {boolean} [single_pick_multi_drop] - Indicates whether the courier
373
- * partner supports single pickup to multiple drop locations.
374
- * @property {boolean} [multi_pick_multi_drop] - Denotes if the courier partner
375
- * offers services for multiple pickups to multiple drop locations.
376
- * @property {boolean} [ewaybill] - Specifies if the courier partner requires or
377
- * supports the generation of e-waybills for shipments.
378
- * @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
379
- * of items allowed in a quality check shipment.
380
- * @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
381
- * quantity of items allowed in a non-quality check shipment.
382
- */
383
- /**
384
- * @typedef CourierPartnerSchemeV2Features
385
- * @property {boolean} [doorstep_qc] - Indicates if the courier partner offers
386
- * doorstep quality check services.
387
- * @property {boolean} [qr] - Specifies whether the courier partner supports QR
388
- * code-based operations.
389
- * @property {boolean} [mps] - Denotes if the courier partner supports
390
- * multi-part shipment services.
391
- * @property {boolean} [ndr] - Indicates if the Non-Delivery Report (NDR)
392
- * feature is supported by the courier partner.
393
- * @property {boolean} [dangerous_goods] - Specifies if the courier partner
394
- * handles the transportation of dangerous goods.
395
- * @property {boolean} [fragile_goods] - Indicates whether the courier partner
396
- * manages the shipment of fragile goods.
397
- * @property {boolean} [restricted_goods] - Indicates if the courier partner
398
- * handles restricted goods, as per regulatory guidelines.
399
- * @property {boolean} [cold_storage_goods] - Denotes if the courier partner
400
- * provides cold storage facilities for goods.
401
- * @property {boolean} [doorstep_exchange] - Indicates if the courier partner
402
- * supports doorstep exchange services.
403
- * @property {boolean} [doorstep_return] - Specifies if the courier partner
404
- * offers doorstep return services.
405
- * @property {boolean} [product_installation] - Indicates if the courier partner
406
- * provides product installation services upon delivery.
407
- * @property {boolean} [openbox_delivery] - Specifies whether the courier
408
- * partner supports open-box delivery, allowing customers to inspect goods
409
- * before accepting.
410
- * @property {boolean} [multi_pick_single_drop] - Indicates if the courier
411
- * partner supports multiple pickups to a single drop location.
412
- * @property {boolean} [single_pick_multi_drop] - Indicates whether the courier
413
- * partner supports single pickup to multiple drop locations.
414
- * @property {boolean} [multi_pick_multi_drop] - Denotes if the courier partner
415
- * offers services for multiple pickups to multiple drop locations.
416
- * @property {boolean} [ewaybill] - Specifies if the courier partner requires or
417
- * supports the generation of e-waybills for shipments.
418
- */
419
- /**
420
- * @typedef CourierPartnerSchemeV2DetailsModel
421
- * @property {string} extension_id - Unique identifier of courier partner extension.
422
- * @property {string} [scheme_id] - Unique identifier of courier partner scheme.
357
+ * @property {string} [scheme_id] - Unique identifier for the scheme, used to
358
+ * fetch or modify scheme details.
423
359
  * @property {string} name - Name of the scheme.
424
360
  * @property {ArithmeticOperations} weight
425
361
  * @property {ArithmeticOperations} [volumetric_weight]
@@ -441,12 +377,16 @@ export = LogisticsPartnerModel;
441
377
  * of items allowed in a quality check shipment.
442
378
  * @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
443
379
  * quantity of items allowed in a non-quality check shipment.
444
- * @property {CourierPartnerSchemeV2Features} feature
380
+ * @property {CourierPartnerSchemeFeatures} feature
445
381
  */
446
382
  /**
447
- * @typedef CourierPartnerV2SchemeModel
448
- * @property {string} extension_id - Unique identifier of courier partner extension.
449
- * @property {string} scheme_id - Unique identifier of courier partner scheme.
383
+ * @typedef CourierPartnerPutSchema
384
+ * @property {string} [extension_id] - Unique identifier of courier partner extension.
385
+ * @property {CreatedBy} [created_by]
386
+ * @property {ModifiedBy} [modified_by]
387
+ * @property {string} [created_on] - The timestamp when the record was created.
388
+ * @property {string} [modified_on] - The timestamp when the record last modified.
389
+ * @property {string} [scheme_id] - Unique identifier of courier partner scheme.
450
390
  * @property {string} [company_id] - Unique identifier of company.
451
391
  * @property {string} name - Name of the scheme.
452
392
  * @property {ArithmeticOperations} weight
@@ -469,22 +409,15 @@ export = LogisticsPartnerModel;
469
409
  * of items allowed in a quality check shipment.
470
410
  * @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
471
411
  * quantity of items allowed in a non-quality check shipment.
472
- * @property {CourierPartnerSchemeV2Features} feature
412
+ * @property {CourierPartnerSchemeFeatures} feature
473
413
  */
474
414
  /**
475
- * @typedef courierPartnerSchemeV2List
476
- * @property {CourierPartnerV2SchemeModel[]} items - List of courier partner schemes
415
+ * @typedef CourierPartnerSchemeList
416
+ * @property {CourierPartnerSchemeModelSchema[]} items - List of courier partner schemes
477
417
  * @property {Page} page
478
418
  */
479
419
  /**
480
- * @typedef ArithmeticOperations
481
- * @property {number} [lt]
482
- * @property {number} [gt]
483
- * @property {number} [lte]
484
- * @property {number} [gte]
485
- */
486
- /**
487
- * @typedef CourierPartnerSchemeV2UpdateDetails
420
+ * @typedef CourierPartnerSchemeUpdateDetails
488
421
  * @property {string} name - Name of the scheme.
489
422
  * @property {ArithmeticOperations} weight
490
423
  * @property {ArithmeticOperations} [volumetric_weight]
@@ -506,210 +439,406 @@ export = LogisticsPartnerModel;
506
439
  * of items allowed in a quality check shipment.
507
440
  * @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
508
441
  * quantity of items allowed in a non-quality check shipment.
509
- * @property {CourierPartnerSchemeV2Features} feature
442
+ * @property {CourierPartnerSchemeFeatures} feature
510
443
  */
511
444
  /**
512
445
  * @typedef GetCountries
513
- * @property {GetCountriesItems[]} items
446
+ * @property {GetCountriesItems[]} items - A list of country objects containing
447
+ * detailed information about each country.
514
448
  * @property {Page} page
515
449
  */
516
450
  /**
517
- * @typedef GetCountriesItems
518
- * @property {string} [id] - Unique identifier of the country.
519
- * @property {string} [name] - Name of the country.
520
- * @property {string} [iso2] - Two-letter ISO code representing the country.
521
- * @property {string} [iso3] - Three-letter ISO code representing the country.
522
- * @property {string[]} [timezones] - List of time zones used in the country
523
- * (e.g., ["America/New_York", "America/Los_Angeles"]).
524
- * @property {HierarchyItems[]} [hierarchy] - Levels within the country (e.g.,
525
- * states, cities) and their slugs (e.g., [{"name": "State", "slug": "state"},
526
- * {"name": "City", "slug": "city"}]).
527
- * @property {string} [phone_code] - International dialing code for the country
528
- * (e.g., "+1").
529
- * @property {string} [currency] - Indicates currency for the country (e.g., "INR").
530
- * @property {string} [type] - Indicates the type of object (e.g., "country").
531
- * @property {string} [latitude] - Geographical latitude of the country (e.g., "37.0902").
532
- * @property {string} [longitude] - Geographical longitude of the country (e.g.,
533
- * "-95.7129").
534
- * @property {string} [display_name] - User-friendly version of the geographical
535
- * data, which may be more descriptive or formatted differently.
536
- * @property {boolean} [has_next_hierarchy] - More detailed hierarchical data is
537
- * available, meaning states, cities, or other regions within the country have
538
- * been populated in the system.
451
+ * @typedef TATUpdateDetails
452
+ * @property {number} [max_delivery_time] - Maximum time required for delivery
453
+ * from the origin to the destination in seconds.
454
+ * @property {number} [min_delivery_time] - Minimum time required for delivery
455
+ * from the origin to the destination in seconds.
456
+ * @property {TATDetails} [forward]
457
+ * @property {TATDetails} [reverse]
539
458
  */
540
459
  /**
541
- * @typedef HierarchyItems
542
- * @property {string} [display_name] - It represent a country display name.
543
- * @property {string} [slug] - A URL-friendly version of the name, often used
544
- * for referencing or querying purposes.
460
+ * @typedef StandardError
461
+ * @property {string} message - A brief description of the error.
545
462
  */
546
463
  /**
547
- * @typedef ValidationError
548
- * @property {string} message - A brief description of the error encountered.
549
- * @property {string} field - The field in the request that caused the error.
464
+ * @typedef ValidationErrors
465
+ * @property {ValidationError[]} errors
550
466
  */
551
467
  /**
552
- * @typedef StandardError
553
- * @property {string} message - A brief description of the error.
468
+ * @typedef CreatedBy
469
+ * @property {string} [id] - Identifier of the user or system that created the object.
554
470
  */
555
- declare class LogisticsPartnerModel {
556
- }
557
- declare namespace LogisticsPartnerModel {
558
- export { BulkRegionServiceabilityTatDetails, BulkRegionServiceabilityTatResultItemData, ErrorResult, FailureResult, BulkRegionServiceabilityTatResult, Page, CourierAccountUpdateDetails, RegionTatItemResult, RegionServiceabilityItemResult, ServiceabilityDetailsResult, ServiceabilityDetails, RegionServiceabilityResult, RegionServiceabilityDetails, RegionTatDetails, RegionTatUpdateDetails, RegionTatResult, BulkRegionJobDetails, BulkRegionResultItemData, BulkRegionResult, CourierAccount, CourierAccountDetailsBody, CourierPartnerAccountFailureResult, CompanyCourierPartnerAccountListResult, CourierAccountResult, CourierPartnerSchemeModel, CourierPartnerSchemeDetailsModel, CourierPartnerSchemeFeatures, CourierPartnerSchemeV2Features, CourierPartnerSchemeV2DetailsModel, CourierPartnerV2SchemeModel, courierPartnerSchemeV2List, ArithmeticOperations, CourierPartnerSchemeV2UpdateDetails, GetCountries, GetCountriesItems, HierarchyItems, ValidationError, StandardError };
559
- }
560
- /** @returns {BulkRegionServiceabilityTatDetails} */
561
- declare function BulkRegionServiceabilityTatDetails(): BulkRegionServiceabilityTatDetails;
562
- type BulkRegionServiceabilityTatDetails = {
563
- /**
564
- * - Name of the country.
565
- */
566
- country: string;
567
- /**
568
- * - Name of the region for which the
569
- * tat/serviceability file needs to be downloaded.
570
- */
571
- region: string;
572
- /**
573
- * - Denotes the type of file.
574
- */
575
- type: string;
576
- };
577
- /** @returns {BulkRegionServiceabilityTatResultItemData} */
578
- declare function BulkRegionServiceabilityTatResultItemData(): BulkRegionServiceabilityTatResultItemData;
579
- type BulkRegionServiceabilityTatResultItemData = {
580
- /**
581
- * - Name of the country.
582
- */
583
- country?: string;
584
- /**
585
- * - Name of the region for which the
586
- * tat/serviceability file needs to be downloaded.
587
- */
588
- region?: string;
589
- /**
590
- * - Denotes the type of data.
591
- */
592
- type?: string;
471
+ /**
472
+ * @typedef ModifiedBy
473
+ * @property {string} [id] - Identifier of the user or system that created the object.
474
+ */
475
+ /**
476
+ * @typedef ArithmeticOperations
477
+ * @property {number} [lt] - Specifies a less than operation, comparing values
478
+ * smaller than the provided value.
479
+ * @property {number} [gt] - Specifies a greater than operation, comparing
480
+ * values larger than the provided value.
481
+ * @property {number} [lte] - Specifies a less than or equal to operation,
482
+ * comparing values smaller than or equal to the provided value.
483
+ * @property {number} [gte] - Specifies a greater than or equal to operation,
484
+ * comparing values larger than or equal to the provided value.
485
+ */
486
+ /**
487
+ * @typedef CourierPartnerSchemeFeatures
488
+ * @property {boolean} [doorstep_qc] - Indicates if the courier partner offers
489
+ * doorstep quality check services.
490
+ * @property {boolean} [qr] - Specifies whether the courier partner supports QR
491
+ * code-based operations.
492
+ * @property {boolean} [mps] - Denotes if the courier partner supports
493
+ * multi-part shipment services.
494
+ * @property {boolean} [ndr] - Indicates if the Non-Delivery Report (NDR)
495
+ * feature is supported by the courier partner.
496
+ * @property {number} [ndr_attempts] - Number of attempts allowed for resolving
497
+ * Non-Delivery Reports (NDR).
498
+ * @property {boolean} [dangerous_goods] - Specifies if the courier partner
499
+ * handles the transportation of dangerous goods.
500
+ * @property {boolean} [fragile_goods] - Indicates whether the courier partner
501
+ * manages the shipment of fragile goods.
502
+ * @property {boolean} [restricted_goods] - Indicates if the courier partner
503
+ * handles restricted goods, as per regulatory guidelines.
504
+ * @property {boolean} [cold_storage_goods] - Denotes if the courier partner
505
+ * provides cold storage facilities for goods.
506
+ * @property {boolean} [doorstep_exchange] - Indicates if the courier partner
507
+ * supports doorstep exchange services.
508
+ * @property {boolean} [doorstep_return] - Specifies if the courier partner
509
+ * offers doorstep return services.
510
+ * @property {boolean} [product_installation] - Indicates if the courier partner
511
+ * provides product installation services upon delivery.
512
+ * @property {boolean} [openbox_delivery] - Specifies whether the courier
513
+ * partner supports open-box delivery, allowing customers to inspect goods
514
+ * before accepting.
515
+ * @property {string} [status_updates] - Describes the type of status updates
516
+ * provided by the courier partner (e.g., real-time, periodic).
517
+ * @property {boolean} [multi_pick_single_drop] - Indicates if the courier
518
+ * partner supports multiple pickups to a single drop location.
519
+ * @property {boolean} [single_pick_multi_drop] - Indicates whether the courier
520
+ * partner supports single pickup to multiple drop locations.
521
+ * @property {boolean} [multi_pick_multi_drop] - Denotes if the courier partner
522
+ * offers services for multiple pickups to multiple drop locations.
523
+ * @property {boolean} [ewaybill] - Specifies if the courier partner requires or
524
+ * supports the generation of e-waybills for shipments.
525
+ * @property {number} [qc_shipment_item_quantity] - Defines the maximum quantity
526
+ * of items allowed in a quality check shipment.
527
+ * @property {number} [non_qc_shipment_item_quantity] - Defines the maximum
528
+ * quantity of items allowed in a non-quality check shipment.
529
+ */
530
+ /**
531
+ * @typedef Error
532
+ * @property {string} [type] - The type of the error.
533
+ * @property {string} [value] - The value associated with the error.
534
+ * @property {string} [message] - The error message describing the issue.
535
+ */
536
+ /**
537
+ * @typedef Page
538
+ * @property {number} [item_total] - The total number of items on the page.
539
+ * @property {string} [next_id] - The identifier for the next page.
540
+ * @property {boolean} [has_previous] - Indicates whether there is a previous page.
541
+ * @property {boolean} [has_next] - Indicates whether there is a next page.
542
+ * @property {number} [current] - The current page number.
543
+ * @property {string} type - The type of the page, such as 'PageType'.
544
+ * @property {number} [size] - The number of items per page.
545
+ * @property {number} [page_size] - The number of items per page.
546
+ */
547
+ /**
548
+ * @typedef TATDetails
549
+ * @property {number} [max_delivery_time] - Maximum time required for delivery
550
+ * from the origin to the destination in seconds.
551
+ * @property {number} [min_delivery_time] - Minimum time required for delivery
552
+ * from the origin to the destination in seconds.
553
+ */
554
+ /**
555
+ * @typedef CourierPartnerSchemeModel
556
+ * @property {string} extension_id - Unique identifier of courier partner extension.
557
+ * @property {string} scheme_id - A string representing the unique identifier
558
+ * for the scheme. This is a required field.
559
+ * @property {string} name - A string that specifies the name of the scheme.
560
+ * This is a required field.
561
+ * @property {ArithmeticOperations} weight
562
+ * @property {ArithmeticOperations} [volumetric_weight]
563
+ * @property {string} transport_type - A string that specifies the type of transport.
564
+ * @property {string} region - A string that indicates the region type.
565
+ * @property {string} delivery_type - A string that defines the delivery type.
566
+ * @property {string[]} payment_mode - An array of strings specifying the
567
+ * payment modes available.
568
+ * @property {string} stage - A string indicating the current stage of the scheme.
569
+ * @property {CourierPartnerSchemeFeatures} feature
570
+ */
571
+ /**
572
+ * @typedef GetCountriesItems
573
+ * @property {string} [id] - A string serving as the unique identifier.
574
+ * @property {string} [sub_type] - A category for classifying the country into a
575
+ * specific subtype.
576
+ * @property {string} [uid] - A globally unique identifier for the country.
577
+ * @property {string} [name] - The official or widely recognized name of the
578
+ * country used in general contexts.
579
+ * @property {string} [iso2] - The 2-letter ISO code for the country.
580
+ * @property {string} [iso3] - The 3-letter ISO code for the country.
581
+ * @property {string[]} [timezones] - A list of timezones associated with the country.
582
+ * @property {HierarchyItems[]} [hierarchy] - A hierarchical list of items
583
+ * representing organizational levels within the country.
584
+ * @property {string} [phone_code] - A country-specific phone code.
585
+ * @property {CurrencyObject} [currency]
586
+ * @property {string} [type] - The type or classification of the country (e.g.,
587
+ * sovereign or dependent).
588
+ * @property {string} [latitude] - The latitude of the central point of the country.
589
+ * @property {string} [longitude] - The longitude of the central point of the country.
590
+ * @property {string} [display_name] - A user-friendly name for the country,
591
+ * typically for display purposes.
592
+ * @property {boolean} [has_next_hierarchy] - A boolean indicating whether
593
+ * additional hierarchical regions or divisions are present.
594
+ */
595
+ /**
596
+ * @typedef HierarchyItems
597
+ * @property {string} [name] - The name of the item as displayed to the user,
598
+ * usually in a UI or listing.
599
+ * @property {string} [display_name] - It represent a country display name.
600
+ * @property {string} [slug] - A slug is a human-readable URL segment, typically
601
+ * generated from a title with special characters removed.
602
+ */
603
+ /**
604
+ * @typedef CurrencyObject
605
+ * @property {string} [code] - A string representing the currency code.
606
+ * @property {string} [name] - A string representing the currency name.
607
+ * @property {string} [symbol] - A string representing the currency symbol.
608
+ */
609
+ /**
610
+ * @typedef ValidationError
611
+ * @property {string} message - A brief description of the error encountered.
612
+ * @property {string} field - The field in the request that caused the error.
613
+ */
614
+ declare class LogisticsPartnerModel {
615
+ }
616
+ declare namespace LogisticsPartnerModel {
617
+ export { CourierPartnerSchemeModelSchema, BulkRegionServiceabilityTatDetails, BulkRegionServiceabilityTatResultItemData, CommonErrorResult, BulkFailureResult, FailureResult, BulkRegionServiceabilityTatResult, RegionTatItemResult, RegionServiceabilityItemResult, ServiceabilityDetailsResult, ServiceabilityDetails, RegionServiceabilityResult, RegionServiceabilityDetails, RegionTatDetails, RegionTatResult, BulkRegionJobDetails, BulkRegionResultItemData, BulkRegionResult, CourierAccountDetailsBody, CompanyCourierPartnerAccountListResult, CourierAccountResult, CourierPartnerSchemeDetailsModel, CourierPartnerPutSchema, CourierPartnerSchemeList, CourierPartnerSchemeUpdateDetails, GetCountries, TATUpdateDetails, StandardError, ValidationErrors, CreatedBy, ModifiedBy, ArithmeticOperations, CourierPartnerSchemeFeatures, Error, Page, TATDetails, CourierPartnerSchemeModel, GetCountriesItems, HierarchyItems, CurrencyObject, ValidationError };
618
+ }
619
+ /** @returns {CourierPartnerSchemeModelSchema} */
620
+ declare function CourierPartnerSchemeModelSchema(): CourierPartnerSchemeModelSchema;
621
+ type CourierPartnerSchemeModelSchema = {
622
+ created_by?: CreatedBy;
593
623
  /**
594
- * - Unique identifier identifying the perticular request.
624
+ * - The timestamp when the record was created.
595
625
  */
596
- batch_id?: string;
626
+ created_on?: string;
627
+ modified_by?: ModifiedBy;
597
628
  /**
598
- * - Current status of the request.
629
+ * - The timestamp when the record last modified.
599
630
  */
600
- status?: string;
631
+ modified_on?: string;
601
632
  /**
602
- * - Information of records which failed
633
+ * - Unique identifier of courier partner extension.
603
634
  */
604
- failed_records?: any[];
635
+ extension_id?: string;
605
636
  /**
606
- * - CDN path of the file.
637
+ * - Unique identifier for the scheme, used to
638
+ * fetch or modify scheme details.
607
639
  */
608
- file_path?: string;
640
+ scheme_id?: string;
641
+ /**
642
+ * - Unique identifier of company.
643
+ */
644
+ company_id?: string;
645
+ /**
646
+ * - Name of the scheme.
647
+ */
648
+ name: string;
649
+ weight: ArithmeticOperations;
650
+ volumetric_weight?: ArithmeticOperations;
651
+ /**
652
+ * - Mode of transport associated with the
653
+ * courier partner scheme.
654
+ */
655
+ transport_type: string;
656
+ /**
657
+ * - Serviceable region associated with the courier
658
+ * partner scheme.
659
+ */
660
+ region: string;
661
+ /**
662
+ * - Type of delivery associated with the
663
+ * courier partner scheme.
664
+ */
665
+ delivery_type: string;
666
+ /**
667
+ * - Mode of payment associated with the
668
+ * courier partner scheme.
669
+ */
670
+ payment_mode: string[];
671
+ /**
672
+ * - Indicates if the courier partner scheme is
673
+ * currently active or inactive.
674
+ */
675
+ stage: string;
676
+ /**
677
+ * - Describes the type of status updates
678
+ * provided by the courier partner (e.g., real-time, periodic).
679
+ */
680
+ status_updates?: string;
681
+ /**
682
+ * - Indicates if the Non-Delivery Report
683
+ * (NDR) feature is supported by the courier partner.
684
+ */
685
+ ndr_attempts?: number;
686
+ /**
687
+ * - Defines the maximum quantity
688
+ * of items allowed in a quality check shipment.
689
+ */
690
+ qc_shipment_item_quantity?: number;
691
+ /**
692
+ * - Defines the maximum
693
+ * quantity of items allowed in a non-quality check shipment.
694
+ */
695
+ non_qc_shipment_item_quantity?: number;
696
+ feature: CourierPartnerSchemeFeatures;
609
697
  };
610
- /** @returns {ErrorResult} */
611
- declare function ErrorResult(): ErrorResult;
612
- type ErrorResult = {
698
+ /** @returns {BulkRegionServiceabilityTatDetails} */
699
+ declare function BulkRegionServiceabilityTatDetails(): BulkRegionServiceabilityTatDetails;
700
+ type BulkRegionServiceabilityTatDetails = {
613
701
  /**
614
- * - Fields containing the error.
702
+ * - Country involved in the operation.
615
703
  */
616
- value: string;
704
+ country: string;
617
705
  /**
618
- * - Description of the error.
706
+ * - Region involved in the operation.
619
707
  */
620
- message: string;
708
+ region: string;
621
709
  /**
622
- * - Type of the error.
710
+ * - Type of operation, either serviceability or TAT.
623
711
  */
624
712
  type: string;
625
713
  };
626
- /** @returns {FailureResult} */
627
- declare function FailureResult(): FailureResult;
628
- type FailureResult = {
714
+ /** @returns {BulkRegionServiceabilityTatResultItemData} */
715
+ declare function BulkRegionServiceabilityTatResultItemData(): BulkRegionServiceabilityTatResultItemData;
716
+ type BulkRegionServiceabilityTatResultItemData = {
629
717
  /**
630
- * - Denotes if the request was successfully executed.
718
+ * - Name of the country.
631
719
  */
632
- success: boolean;
633
- error: ErrorResult[];
634
- };
635
- /** @returns {BulkRegionServiceabilityTatResult} */
636
- declare function BulkRegionServiceabilityTatResult(): BulkRegionServiceabilityTatResult;
637
- type BulkRegionServiceabilityTatResult = {
638
- items?: BulkRegionServiceabilityTatResultItemData[];
639
- page?: Page;
640
- };
641
- /** @returns {Page} */
642
- declare function Page(): Page;
643
- type Page = {
720
+ country?: string;
644
721
  /**
645
- * - The total number of items on the page.
722
+ * - Name of the region for which the
723
+ * tat/serviceability file needs to be downloaded.
646
724
  */
647
- item_total?: number;
725
+ region?: string;
648
726
  /**
649
- * - The identifier for the next page.
727
+ * - Denotes the type of data.
650
728
  */
651
- next_id?: string;
729
+ type?: string;
652
730
  /**
653
- * - Indicates whether there is a previous page.
731
+ * - A unique identifier for the performed batch operation.
654
732
  */
655
- has_previous?: boolean;
733
+ batch_id?: string;
656
734
  /**
657
- * - Indicates whether there is a next page.
735
+ * - Current status of the request.
658
736
  */
659
- has_next?: boolean;
737
+ status?: string;
660
738
  /**
661
- * - The current page number.
739
+ * - Information of records which failed
662
740
  */
663
- current?: number;
741
+ failed_records?: any[];
664
742
  /**
665
- * - The type of the page, such as 'PageType'.
743
+ * - CDN path of the file.
666
744
  */
667
- type: string;
745
+ file_path?: string;
746
+ };
747
+ /** @returns {CommonErrorResult} */
748
+ declare function CommonErrorResult(): CommonErrorResult;
749
+ type CommonErrorResult = {
668
750
  /**
669
- * - The number of items per page.
751
+ * - An array of items referencing the ErrorResult
752
+ * schema, which likely contains detailed information about the errors.
670
753
  */
671
- size?: number;
754
+ error?: Error[];
672
755
  };
673
- /** @returns {CourierAccountUpdateDetails} */
674
- declare function CourierAccountUpdateDetails(): CourierAccountUpdateDetails;
675
- type CourierAccountUpdateDetails = {
756
+ /** @returns {BulkFailureResult} */
757
+ declare function BulkFailureResult(): BulkFailureResult;
758
+ type BulkFailureResult = {
676
759
  /**
677
- * - Unique identifier of courier partner extension.
760
+ * - Whether operation was successful.
678
761
  */
679
- extension_id: string;
762
+ success?: boolean;
680
763
  /**
681
- * - Unique identifier of courier partner scheme.
764
+ * - An array containing error details.
682
765
  */
683
- scheme_id: string;
766
+ error: Error[];
767
+ };
768
+ /** @returns {FailureResult} */
769
+ declare function FailureResult(): FailureResult;
770
+ type FailureResult = {
684
771
  /**
685
- * - Denotes if the account is of self delivery type.
772
+ * - Whether operation was successful.
686
773
  */
687
- is_self_ship: boolean;
774
+ success?: boolean;
688
775
  /**
689
- * - Denotes whether the account is in enabled or disabled stage.
776
+ * - Array of error details.
690
777
  */
691
- stage: string;
778
+ error?: Error[];
779
+ };
780
+ /** @returns {BulkRegionServiceabilityTatResult} */
781
+ declare function BulkRegionServiceabilityTatResult(): BulkRegionServiceabilityTatResult;
782
+ type BulkRegionServiceabilityTatResult = {
692
783
  /**
693
- * - Denotes whether it is the seller's own
694
- * account or not.
784
+ * - Array of
785
+ * bulk region serviceability or TAT result items.
695
786
  */
696
- is_own_account: boolean;
787
+ items?: BulkRegionServiceabilityTatResultItemData[];
788
+ page?: Page;
697
789
  };
698
790
  /** @returns {RegionTatItemResult} */
699
791
  declare function RegionTatItemResult(): RegionTatItemResult;
700
792
  type RegionTatItemResult = {
793
+ /**
794
+ * - An array that contains items of region tat.
795
+ */
701
796
  items: RegionTatResult[];
702
797
  page: Page;
703
798
  };
704
799
  /** @returns {RegionServiceabilityItemResult} */
705
800
  declare function RegionServiceabilityItemResult(): RegionServiceabilityItemResult;
706
801
  type RegionServiceabilityItemResult = {
802
+ /**
803
+ * - An array that contains items
804
+ * of region serviceability.
805
+ */
707
806
  items: RegionServiceabilityResult[];
708
807
  page: Page;
709
808
  };
710
809
  /** @returns {ServiceabilityDetailsResult} */
711
810
  declare function ServiceabilityDetailsResult(): ServiceabilityDetailsResult;
712
811
  type ServiceabilityDetailsResult = {
812
+ /**
813
+ * - Time of day by which pickups must be
814
+ * scheduled to be processed on the same day.
815
+ */
816
+ pickup_cutoff?: string;
817
+ /**
818
+ * - ISO2 code representing the country where
819
+ * the serviceability is being specified.
820
+ */
821
+ country_code?: string;
822
+ /**
823
+ * - Code representing the state or province
824
+ * within the country where the serviceability is being specified.
825
+ */
826
+ state_code?: string;
827
+ /**
828
+ * - Code representing the city within the state
829
+ * where the serviceability is being specified.
830
+ */
831
+ city_code?: string;
832
+ /**
833
+ * - Code representing a specific sector or
834
+ * district within the city where the serviceability is being specified.
835
+ */
836
+ sector_code?: string;
837
+ /**
838
+ * - A string indicating the postal code or PIN
839
+ * code of the address area.
840
+ */
841
+ pincode?: string;
713
842
  /**
714
843
  * - Boolean value indicating whether
715
844
  * first-mile service is available or not.
@@ -720,16 +849,16 @@ type ServiceabilityDetailsResult = {
720
849
  * service is available or not.
721
850
  */
722
851
  last_mile?: boolean;
723
- /**
724
- * - Boolean value indicating whether a
725
- * region is first-mile serviceable or not in return pickup.
726
- */
727
- reverse_pickup?: boolean;
728
852
  /**
729
853
  * - Limit on the amount of cash on delivery
730
854
  * (COD) payments allowed in the specified region.
731
855
  */
732
856
  cod_limit?: number;
857
+ /**
858
+ * - Limit on the amount of prepaid payments
859
+ * allowed in the specified region.
860
+ */
861
+ prepaid_limit?: number;
733
862
  /**
734
863
  * - Indicates if doorstep return service
735
864
  * is available. This refers to the ability to return items directly from the
@@ -743,17 +872,37 @@ type ServiceabilityDetailsResult = {
743
872
  */
744
873
  doorstep_qc?: boolean;
745
874
  /**
746
- * - Time of day by which pickups must be
747
- * scheduled to be processed on the same day.
875
+ * - Time of day by which pickups
876
+ * must be scheduled to be processed on the same day in the forward journey.
748
877
  */
749
- pickup_cutoff?: string;
878
+ forward_pickup_cutoff?: string;
879
+ /**
880
+ * - Time of day by which pickups
881
+ * must be scheduled to be processed on the same day in the reverse journey.
882
+ */
883
+ reverse_pickup_cutoff?: string;
884
+ /**
885
+ * - Indicates whether the product
886
+ * exchange happens directly between the buyer and seller (e.g., in person),
887
+ * instead of through a third-party service.
888
+ */
889
+ hand_to_hand_exchange?: boolean;
890
+ /**
891
+ * - List of holidays for a courier partner scheme.
892
+ */
893
+ holiday_list?: string[];
894
+ /**
895
+ * - Boolean value indicating whether
896
+ * reverse pickup services is available.
897
+ */
898
+ reverse_pickup?: boolean;
750
899
  /**
751
900
  * - Boolean value indicating whether
752
901
  * installation services are available in the specified region or not.
753
902
  */
754
903
  installation?: boolean;
755
904
  /**
756
- * - Unique identifier for the serviceability record.
905
+ * - A string serving as the unique identifier.
757
906
  */
758
907
  id?: string;
759
908
  };
@@ -770,11 +919,6 @@ type ServiceabilityDetails = {
770
919
  * service is available or not.
771
920
  */
772
921
  last_mile?: boolean;
773
- /**
774
- * - Boolean value indicating whether a
775
- * region is first-mile serviceable or not in return pickup.
776
- */
777
- reverse_pickup?: boolean;
778
922
  /**
779
923
  * - Limit on the amount of cash on delivery
780
924
  * (COD) payments allowed in the specified region.
@@ -793,19 +937,44 @@ type ServiceabilityDetails = {
793
937
  */
794
938
  doorstep_qc?: boolean;
795
939
  /**
796
- * - Time of day by which pickups must be
797
- * scheduled to be processed on the same day.
940
+ * - Time of day by which pickups
941
+ * must be scheduled to be processed on the same day in the forward journey.
798
942
  */
799
- pickup_cutoff?: string;
943
+ forward_pickup_cutoff?: string;
944
+ /**
945
+ * - Time of day by which pickups
946
+ * must be scheduled to be processed on the same day in the reverse journey.
947
+ */
948
+ reverse_pickup_cutoff?: string;
949
+ /**
950
+ * - Indicates whether the product
951
+ * exchange happens directly between the buyer and seller (e.g., in person),
952
+ * instead of through a third-party service.
953
+ */
954
+ hand_to_hand_exchange?: boolean;
955
+ /**
956
+ * - List of holidays for a courier partner scheme.
957
+ */
958
+ holiday_list?: string[];
800
959
  /**
801
960
  * - Boolean value indicating whether
802
961
  * installation services are available in the specified region or not.
803
962
  */
804
963
  installation?: boolean;
964
+ /**
965
+ * - Time of day by which pickups must be
966
+ * scheduled to be processed on the same day.
967
+ */
968
+ pickup_cutoff?: string;
805
969
  };
806
970
  /** @returns {RegionServiceabilityResult} */
807
971
  declare function RegionServiceabilityResult(): RegionServiceabilityResult;
808
972
  type RegionServiceabilityResult = {
973
+ /**
974
+ * - Time of day by which pickups must be
975
+ * scheduled to be processed on the same day.
976
+ */
977
+ pickup_cutoff?: string;
809
978
  /**
810
979
  * - ISO2 code representing the country where
811
980
  * the serviceability is being specified.
@@ -827,8 +996,8 @@ type RegionServiceabilityResult = {
827
996
  */
828
997
  sector_code?: string;
829
998
  /**
830
- * - Postal or ZIP code for the specific area
831
- * within the city where the serviceability is being specified.
999
+ * - A string indicating the postal code or PIN
1000
+ * code of the address area.
832
1001
  */
833
1002
  pincode?: string;
834
1003
  /**
@@ -841,16 +1010,16 @@ type RegionServiceabilityResult = {
841
1010
  * service is available or not.
842
1011
  */
843
1012
  last_mile?: boolean;
844
- /**
845
- * - Boolean value indicating whether a
846
- * region is first-mile serviceable or not in return pickup.
847
- */
848
- reverse_pickup?: boolean;
849
1013
  /**
850
1014
  * - Limit on the amount of cash on delivery
851
1015
  * (COD) payments allowed in the specified region.
852
1016
  */
853
1017
  cod_limit?: number;
1018
+ /**
1019
+ * - Limit on the amount of prepaid payments
1020
+ * allowed in the specified region.
1021
+ */
1022
+ prepaid_limit?: number;
854
1023
  /**
855
1024
  * - Indicates if doorstep return service
856
1025
  * is available. This refers to the ability to return items directly from the
@@ -864,17 +1033,36 @@ type RegionServiceabilityResult = {
864
1033
  */
865
1034
  doorstep_qc?: boolean;
866
1035
  /**
867
- * - Time of day by which pickups must be
868
- * scheduled to be processed on the same day.
1036
+ * - Indicates if reverse pickup is available.
869
1037
  */
870
- pickup_cutoff?: string;
1038
+ reverse_pickup?: boolean;
1039
+ /**
1040
+ * - Time of day by which pickups
1041
+ * must be scheduled to be processed on the same day in the forward journey.
1042
+ */
1043
+ forward_pickup_cutoff?: string;
1044
+ /**
1045
+ * - Time of day by which pickups
1046
+ * must be scheduled to be processed on the same day in the reverse journey.
1047
+ */
1048
+ reverse_pickup_cutoff?: string;
1049
+ /**
1050
+ * - Indicates whether the product
1051
+ * exchange happens directly between the buyer and seller (e.g., in person),
1052
+ * instead of through a third-party service.
1053
+ */
1054
+ hand_to_hand_exchange?: boolean;
1055
+ /**
1056
+ * - List of holidays for a courier partner scheme.
1057
+ */
1058
+ holiday_list?: string[];
871
1059
  /**
872
1060
  * - Boolean value indicating whether
873
1061
  * installation services are available in the specified region or not.
874
1062
  */
875
1063
  installation?: boolean;
876
1064
  /**
877
- * - Unique identifier for the serviceability record.
1065
+ * - A string serving as the unique identifier.
878
1066
  */
879
1067
  id: string;
880
1068
  };
@@ -902,8 +1090,8 @@ type RegionServiceabilityDetails = {
902
1090
  */
903
1091
  sector_code?: string;
904
1092
  /**
905
- * - Postal or ZIP code for the specific area
906
- * within the city where the serviceability is being specified.
1093
+ * - A string indicating the postal code or PIN
1094
+ * code of the address area.
907
1095
  */
908
1096
  pincode?: string;
909
1097
  /**
@@ -916,11 +1104,6 @@ type RegionServiceabilityDetails = {
916
1104
  * service is available or not.
917
1105
  */
918
1106
  last_mile?: boolean;
919
- /**
920
- * - Boolean value indicating whether a
921
- * region is first-mile serviceable or not in return pickup.
922
- */
923
- reverse_pickup?: boolean;
924
1107
  /**
925
1108
  * - Limit on the amount of cash on delivery
926
1109
  * (COD) payments allowed in the specified region.
@@ -938,11 +1121,36 @@ type RegionServiceabilityDetails = {
938
1121
  * on items at the customer's doorstep.
939
1122
  */
940
1123
  doorstep_qc?: boolean;
1124
+ /**
1125
+ * - Time of day by which pickups
1126
+ * must be scheduled to be processed on the same day in the forward journey.
1127
+ */
1128
+ forward_pickup_cutoff?: string;
941
1129
  /**
942
1130
  * - Time of day by which pickups must be
943
1131
  * scheduled to be processed on the same day.
944
1132
  */
945
1133
  pickup_cutoff?: string;
1134
+ /**
1135
+ * - Time of day by which pickups
1136
+ * must be scheduled to be processed on the same day in the reverse journey.
1137
+ */
1138
+ reverse_pickup_cutoff?: string;
1139
+ /**
1140
+ * - Indicates whether the product
1141
+ * exchange happens directly between the buyer and seller (e.g., in person),
1142
+ * instead of through a third-party service.
1143
+ */
1144
+ hand_to_hand_exchange?: boolean;
1145
+ /**
1146
+ * - Limit on the amount of prepaid payments
1147
+ * allowed in the specified region.
1148
+ */
1149
+ prepaid_limit?: number;
1150
+ /**
1151
+ * - List of holidays for a courier partner scheme.
1152
+ */
1153
+ holiday_list?: string[];
946
1154
  /**
947
1155
  * - Boolean value indicating whether
948
1156
  * installation services are available in the specified region or not.
@@ -952,6 +1160,16 @@ type RegionServiceabilityDetails = {
952
1160
  /** @returns {RegionTatDetails} */
953
1161
  declare function RegionTatDetails(): RegionTatDetails;
954
1162
  type RegionTatDetails = {
1163
+ /**
1164
+ * - Maximum time required for delivery
1165
+ * from the origin to the destination in seconds.
1166
+ */
1167
+ max_delivery_time?: number;
1168
+ /**
1169
+ * - Minimum time required for delivery
1170
+ * from the origin to the destination in seconds.
1171
+ */
1172
+ min_delivery_time?: number;
955
1173
  /**
956
1174
  * - ISO2 code representing the country of
957
1175
  * origin for the delivery.
@@ -973,7 +1191,8 @@ type RegionTatDetails = {
973
1191
  */
974
1192
  from_sector_code?: string;
975
1193
  /**
976
- * - Postal or ZIP code of the origin area.
1194
+ * - A string indicating the postal code or
1195
+ * PIN code of the address area.
977
1196
  */
978
1197
  from_pincode?: string;
979
1198
  /**
@@ -996,37 +1215,26 @@ type RegionTatDetails = {
996
1215
  */
997
1216
  to_sector_code?: string;
998
1217
  /**
999
- * - Postal or ZIP code of the destination area.
1218
+ * - A string indicating the postal code or PIN
1219
+ * code of the address area.
1000
1220
  */
1001
1221
  to_pincode?: string;
1002
- /**
1003
- * - Maximum time required for delivery
1004
- * from the origin to the destination in seconds.
1005
- */
1006
- max_delivery_time?: number;
1222
+ forward?: TATDetails;
1223
+ reverse?: TATDetails;
1224
+ };
1225
+ /** @returns {RegionTatResult} */
1226
+ declare function RegionTatResult(): RegionTatResult;
1227
+ type RegionTatResult = {
1007
1228
  /**
1008
1229
  * - Minimum time required for delivery
1009
1230
  * from the origin to the destination in seconds.
1010
1231
  */
1011
1232
  min_delivery_time?: number;
1012
- };
1013
- /** @returns {RegionTatUpdateDetails} */
1014
- declare function RegionTatUpdateDetails(): RegionTatUpdateDetails;
1015
- type RegionTatUpdateDetails = {
1016
1233
  /**
1017
1234
  * - Maximum time required for delivery
1018
1235
  * from the origin to the destination in seconds.
1019
1236
  */
1020
1237
  max_delivery_time?: number;
1021
- /**
1022
- * - Minimum time required for delivery
1023
- * from the origin to the destination in seconds.
1024
- */
1025
- min_delivery_time?: number;
1026
- };
1027
- /** @returns {RegionTatResult} */
1028
- declare function RegionTatResult(): RegionTatResult;
1029
- type RegionTatResult = {
1030
1238
  /**
1031
1239
  * - ISO2 code representing the country of
1032
1240
  * origin for the delivery.
@@ -1048,7 +1256,8 @@ type RegionTatResult = {
1048
1256
  */
1049
1257
  from_sector_code?: string;
1050
1258
  /**
1051
- * - Postal or ZIP code of the origin area.
1259
+ * - A string indicating the postal code or
1260
+ * PIN code of the address area.
1052
1261
  */
1053
1262
  from_pincode?: string;
1054
1263
  /**
@@ -1071,21 +1280,14 @@ type RegionTatResult = {
1071
1280
  */
1072
1281
  to_sector_code?: string;
1073
1282
  /**
1074
- * - Postal or ZIP code of the destination area.
1283
+ * - A string indicating the postal code or PIN
1284
+ * code of the address area.
1075
1285
  */
1076
1286
  to_pincode?: string;
1287
+ forward?: TATDetails;
1288
+ reverse?: TATDetails;
1077
1289
  /**
1078
- * - Maximum time required for delivery
1079
- * from the origin to the destination in seconds.
1080
- */
1081
- max_delivery_time?: number;
1082
- /**
1083
- * - Minimum time required for delivery
1084
- * from the origin to the destination in seconds.
1085
- */
1086
- min_delivery_time?: number;
1087
- /**
1088
- * - Unique identifier for the delivery time record.
1290
+ * - A string serving as the unique identifier.
1089
1291
  */
1090
1292
  id: string;
1091
1293
  };
@@ -1093,21 +1295,20 @@ type RegionTatResult = {
1093
1295
  declare function BulkRegionJobDetails(): BulkRegionJobDetails;
1094
1296
  type BulkRegionJobDetails = {
1095
1297
  /**
1096
- * - CDN path of the uploaded csv file for bulk import.
1298
+ * - Path to the file used in the bulk operation.
1097
1299
  */
1098
1300
  file_path?: string;
1099
1301
  /**
1100
- * - Country for which the tat or serviceability is
1101
- * to be imported or exported.
1302
+ * - Country involved in the bulk operation.
1102
1303
  */
1103
1304
  country: string;
1104
1305
  /**
1105
- * - Denotes the import or export action to be performed.
1306
+ * - Action type for the bulk operation, either import
1307
+ * or export.
1106
1308
  */
1107
1309
  action: string;
1108
1310
  /**
1109
- * - Region of the country for which import or export
1110
- * is triggered.
1311
+ * - Region involved in the bulk operation.
1111
1312
  */
1112
1313
  region: string;
1113
1314
  };
@@ -1115,129 +1316,100 @@ type BulkRegionJobDetails = {
1115
1316
  declare function BulkRegionResultItemData(): BulkRegionResultItemData;
1116
1317
  type BulkRegionResultItemData = {
1117
1318
  /**
1118
- * - CDN path of the file which was used for bulk import.
1319
+ * - Path to the file associated with the result item.
1119
1320
  */
1120
- file_path?: string;
1321
+ file_path: string;
1121
1322
  /**
1122
- * - Count of the failed records.
1323
+ * - Number of failed records in the operation.
1123
1324
  */
1124
1325
  failed?: number;
1125
1326
  /**
1126
- * - Information of records which failed.
1327
+ * - Array of failed records with
1328
+ * additional properties.
1127
1329
  */
1128
1330
  failed_records?: any[];
1129
1331
  /**
1130
- * - Denotes the import or export action performed.
1332
+ * - Action type for the result item.
1131
1333
  */
1132
1334
  action: string;
1133
1335
  /**
1134
- * - Unique id to identify the import or export query.
1336
+ * - A unique identifier for the performed batch operation.
1135
1337
  */
1136
1338
  batch_id: string;
1137
1339
  /**
1138
- * - Country for which the import or export action is
1139
- * performed.
1340
+ * - Country associated with the result item.
1140
1341
  */
1141
1342
  country: string;
1142
1343
  /**
1143
- * - Denoted if the import or export was successful
1144
- * or failure.
1344
+ * - Number of successful records in the operation.
1145
1345
  */
1146
1346
  success?: number;
1147
1347
  /**
1148
- * - Region of the country for which import or export
1149
- * is triggered.
1348
+ * - Region associated with the result item.
1150
1349
  */
1151
1350
  region: string;
1152
1351
  /**
1153
- * - Current status of the import or export action performed.
1352
+ * - Current status of the result item.
1154
1353
  */
1155
1354
  status: string;
1156
1355
  /**
1157
- * - Count of total records.
1356
+ * - Total number of records processed.
1158
1357
  */
1159
1358
  total?: number;
1160
1359
  /**
1161
- * - Path of the error file.
1360
+ * - Path to the file containing error details.
1162
1361
  */
1163
1362
  error_file_path?: string;
1164
1363
  };
1165
1364
  /** @returns {BulkRegionResult} */
1166
1365
  declare function BulkRegionResult(): BulkRegionResult;
1167
1366
  type BulkRegionResult = {
1168
- items: BulkRegionResultItemData[];
1169
- page: Page;
1170
- };
1171
- /** @returns {CourierAccount} */
1172
- declare function CourierAccount(): CourierAccount;
1173
- type CourierAccount = {
1174
- /**
1175
- * - Unique identifier of courier partner extension.
1176
- */
1177
- extension_id: string;
1178
- /**
1179
- * - Unique identifier of courier partner scheme
1180
- * and company id combination.
1181
- */
1182
- account_id: string;
1183
1367
  /**
1184
- * - Unique identifier of courier partner scheme.
1185
- */
1186
- scheme_id: string;
1187
- /**
1188
- * - Denotes if the account is of self delivery type.
1189
- */
1190
- is_self_ship: boolean;
1191
- /**
1192
- * - Denotes whether the account is in enabled or disabled stage.
1193
- */
1194
- stage: string;
1195
- /**
1196
- * - Denotes whether it is the seller's own
1197
- * account or not.
1368
+ * - Array of bulk region result items.
1198
1369
  */
1199
- is_own_account: boolean;
1370
+ items: BulkRegionResultItemData[];
1371
+ page: Page;
1200
1372
  };
1201
1373
  /** @returns {CourierAccountDetailsBody} */
1202
1374
  declare function CourierAccountDetailsBody(): CourierAccountDetailsBody;
1203
1375
  type CourierAccountDetailsBody = {
1204
1376
  /**
1205
- * - Unique identifier of courier partner extension.
1377
+ * - The unique identifier for the extension
1378
+ * linked to the courier account.
1206
1379
  */
1207
1380
  extension_id: string;
1208
1381
  /**
1209
- * - Unique identifier of courier partner scheme
1210
- * and company id combination.
1382
+ * - The unique identifier for the courier account.
1211
1383
  */
1212
1384
  account_id?: string;
1213
1385
  /**
1214
- * - Unique identifier of courier account.
1386
+ * - The identifier for the scheme associated with
1387
+ * the courier account.
1215
1388
  */
1216
1389
  scheme_id: string;
1217
1390
  /**
1218
- * - Denotes if the account is of self delivery type.
1391
+ * - Indicates whether the courier account
1392
+ * supports self-shipping (true if it does, false otherwise).
1219
1393
  */
1220
1394
  is_self_ship: boolean;
1221
1395
  /**
1222
- * - Denotes whether the courier account is in enabled
1223
- * or disabled stage.
1396
+ * - The current stage of the courier account, either
1397
+ * 'enabled' or 'disabled'.
1224
1398
  */
1225
1399
  stage: string;
1226
1400
  /**
1227
- * - Denotes whether it is the seller's own
1228
- * account or not.
1401
+ * - Indicates whether the courier account is
1402
+ * an own account (true if it is, false otherwise).
1229
1403
  */
1230
1404
  is_own_account: boolean;
1231
1405
  };
1232
- /** @returns {CourierPartnerAccountFailureResult} */
1233
- declare function CourierPartnerAccountFailureResult(): CourierPartnerAccountFailureResult;
1234
- type CourierPartnerAccountFailureResult = {
1235
- success: boolean;
1236
- error: ErrorResult[];
1237
- };
1238
1406
  /** @returns {CompanyCourierPartnerAccountListResult} */
1239
1407
  declare function CompanyCourierPartnerAccountListResult(): CompanyCourierPartnerAccountListResult;
1240
1408
  type CompanyCourierPartnerAccountListResult = {
1409
+ /**
1410
+ * - An array containing multiple
1411
+ * instances of CourierAccountResult, which details individual courier accounts.
1412
+ */
1241
1413
  items: CourierAccountResult[];
1242
1414
  page: Page;
1243
1415
  };
@@ -1245,43 +1417,58 @@ type CompanyCourierPartnerAccountListResult = {
1245
1417
  declare function CourierAccountResult(): CourierAccountResult;
1246
1418
  type CourierAccountResult = {
1247
1419
  /**
1248
- * - Unique identifier of courier partner scheme
1249
- * and company id combination.
1420
+ * - A string that uniquely identifies the courier account.
1250
1421
  */
1251
1422
  account_id: string;
1252
1423
  /**
1253
- * - Unique identifier of courier partner scheme.
1424
+ * - The unique identifier of the company.
1425
+ */
1426
+ company_id?: number;
1427
+ /**
1428
+ * - A string that specifies the unique identifier
1429
+ * for the scheme associated with the account
1254
1430
  */
1255
1431
  scheme_id: string;
1432
+ /**
1433
+ * - A string that uniquely identifies the
1434
+ * courier partner extension.
1435
+ */
1436
+ extension_id?: string;
1437
+ /**
1438
+ * - A boolean indicating whether the account
1439
+ * is for self-shipping.
1440
+ */
1256
1441
  is_self_ship: boolean;
1257
1442
  /**
1258
- * - Denotes whether the courier account is in enabled
1259
- * or disabled stage.
1443
+ * - A string indicating the current stage of the
1444
+ * account, which can be either enabled or disabled.
1260
1445
  */
1261
1446
  stage: string;
1262
1447
  /**
1263
- * - Denotes whether it is the seller's own
1264
- * account or not.
1448
+ * - A boolean indicating whether the account
1449
+ * is owned by the company.
1265
1450
  */
1266
1451
  is_own_account: boolean;
1267
1452
  scheme_rules: CourierPartnerSchemeModel;
1268
1453
  };
1269
- /** @returns {CourierPartnerSchemeModel} */
1270
- declare function CourierPartnerSchemeModel(): CourierPartnerSchemeModel;
1271
- type CourierPartnerSchemeModel = {
1454
+ /** @returns {CourierPartnerSchemeDetailsModel} */
1455
+ declare function CourierPartnerSchemeDetailsModel(): CourierPartnerSchemeDetailsModel;
1456
+ type CourierPartnerSchemeDetailsModel = {
1272
1457
  /**
1273
1458
  * - Unique identifier of courier partner extension.
1274
1459
  */
1275
1460
  extension_id: string;
1276
1461
  /**
1277
- * - Unique identifier of courier partner scheme.
1462
+ * - Unique identifier for the scheme, used to
1463
+ * fetch or modify scheme details.
1278
1464
  */
1279
- scheme_id: string;
1465
+ scheme_id?: string;
1280
1466
  /**
1281
- * - Name of the scheme
1467
+ * - Name of the scheme.
1282
1468
  */
1283
1469
  name: string;
1284
1470
  weight: ArithmeticOperations;
1471
+ volumetric_weight?: ArithmeticOperations;
1285
1472
  /**
1286
1473
  * - Mode of transport associated with the
1287
1474
  * courier partner scheme.
@@ -1307,24 +1494,59 @@ type CourierPartnerSchemeModel = {
1307
1494
  * currently active or inactive.
1308
1495
  */
1309
1496
  stage: string;
1497
+ /**
1498
+ * - Describes the type of status updates
1499
+ * provided by the courier partner (e.g., real-time, periodic).
1500
+ */
1501
+ status_updates?: string;
1502
+ /**
1503
+ * - Indicates if the Non-Delivery Report
1504
+ * (NDR) feature is supported by the courier partner.
1505
+ */
1506
+ ndr_attempts?: number;
1507
+ /**
1508
+ * - Defines the maximum quantity
1509
+ * of items allowed in a quality check shipment.
1510
+ */
1511
+ qc_shipment_item_quantity?: number;
1512
+ /**
1513
+ * - Defines the maximum
1514
+ * quantity of items allowed in a non-quality check shipment.
1515
+ */
1516
+ non_qc_shipment_item_quantity?: number;
1310
1517
  feature: CourierPartnerSchemeFeatures;
1311
1518
  };
1312
- /** @returns {CourierPartnerSchemeDetailsModel} */
1313
- declare function CourierPartnerSchemeDetailsModel(): CourierPartnerSchemeDetailsModel;
1314
- type CourierPartnerSchemeDetailsModel = {
1519
+ /** @returns {CourierPartnerPutSchema} */
1520
+ declare function CourierPartnerPutSchema(): CourierPartnerPutSchema;
1521
+ type CourierPartnerPutSchema = {
1315
1522
  /**
1316
1523
  * - Unique identifier of courier partner extension.
1317
1524
  */
1318
- extension_id: string;
1525
+ extension_id?: string;
1526
+ created_by?: CreatedBy;
1527
+ modified_by?: ModifiedBy;
1528
+ /**
1529
+ * - The timestamp when the record was created.
1530
+ */
1531
+ created_on?: string;
1532
+ /**
1533
+ * - The timestamp when the record last modified.
1534
+ */
1535
+ modified_on?: string;
1319
1536
  /**
1320
1537
  * - Unique identifier of courier partner scheme.
1321
1538
  */
1322
1539
  scheme_id?: string;
1323
1540
  /**
1324
- * - Name of the courier partner scheme.
1541
+ * - Unique identifier of company.
1542
+ */
1543
+ company_id?: string;
1544
+ /**
1545
+ * - Name of the scheme.
1325
1546
  */
1326
1547
  name: string;
1327
1548
  weight: ArithmeticOperations;
1549
+ volumetric_weight?: ArithmeticOperations;
1328
1550
  /**
1329
1551
  * - Mode of transport associated with the
1330
1552
  * courier partner scheme.
@@ -1350,116 +1572,175 @@ type CourierPartnerSchemeDetailsModel = {
1350
1572
  * currently active or inactive.
1351
1573
  */
1352
1574
  stage: string;
1575
+ /**
1576
+ * - Describes the type of status updates
1577
+ * provided by the courier partner (e.g., real-time, periodic).
1578
+ */
1579
+ status_updates?: string;
1580
+ /**
1581
+ * - Indicates if the Non-Delivery Report
1582
+ * (NDR) feature is supported by the courier partner.
1583
+ */
1584
+ ndr_attempts?: number;
1585
+ /**
1586
+ * - Defines the maximum quantity
1587
+ * of items allowed in a quality check shipment.
1588
+ */
1589
+ qc_shipment_item_quantity?: number;
1590
+ /**
1591
+ * - Defines the maximum
1592
+ * quantity of items allowed in a non-quality check shipment.
1593
+ */
1594
+ non_qc_shipment_item_quantity?: number;
1353
1595
  feature: CourierPartnerSchemeFeatures;
1354
1596
  };
1355
- /** @returns {CourierPartnerSchemeFeatures} */
1356
- declare function CourierPartnerSchemeFeatures(): CourierPartnerSchemeFeatures;
1357
- type CourierPartnerSchemeFeatures = {
1597
+ /** @returns {CourierPartnerSchemeList} */
1598
+ declare function CourierPartnerSchemeList(): CourierPartnerSchemeList;
1599
+ type CourierPartnerSchemeList = {
1358
1600
  /**
1359
- * - Indicates if the courier partner offers
1360
- * doorstep quality check services.
1601
+ * - List of courier partner schemes
1361
1602
  */
1362
- doorstep_qc?: boolean;
1603
+ items: CourierPartnerSchemeModelSchema[];
1604
+ page: Page;
1605
+ };
1606
+ /** @returns {CourierPartnerSchemeUpdateDetails} */
1607
+ declare function CourierPartnerSchemeUpdateDetails(): CourierPartnerSchemeUpdateDetails;
1608
+ type CourierPartnerSchemeUpdateDetails = {
1363
1609
  /**
1364
- * - Specifies whether the courier partner supports QR
1365
- * code-based operations.
1610
+ * - Name of the scheme.
1366
1611
  */
1367
- qr?: boolean;
1612
+ name: string;
1613
+ weight: ArithmeticOperations;
1614
+ volumetric_weight?: ArithmeticOperations;
1368
1615
  /**
1369
- * - Denotes if the courier partner supports
1370
- * multi-part shipment services.
1616
+ * - Mode of transport associated with the
1617
+ * courier partner scheme.
1371
1618
  */
1372
- mps?: boolean;
1619
+ transport_type: string;
1373
1620
  /**
1374
- * - Indicates if the Non-Delivery Report (NDR)
1375
- * feature is supported by the courier partner.
1621
+ * - Serviceable region associated with the courier
1622
+ * partner scheme.
1376
1623
  */
1377
- ndr?: boolean;
1624
+ region: string;
1378
1625
  /**
1379
- * - Number of attempts allowed for resolving
1380
- * Non-Delivery Reports (NDR).
1626
+ * - Type of delivery associated with the
1627
+ * courier partner scheme.
1381
1628
  */
1382
- ndr_attempts?: number;
1629
+ delivery_type: string;
1383
1630
  /**
1384
- * - Specifies if the courier partner
1385
- * handles the transportation of dangerous goods.
1631
+ * - Mode of payment associated with the
1632
+ * courier partner scheme.
1386
1633
  */
1387
- dangerous_goods?: boolean;
1634
+ payment_mode: string[];
1388
1635
  /**
1389
- * - Indicates whether the courier partner
1390
- * manages the shipment of fragile goods.
1636
+ * - Indicates if the courier partner scheme is
1637
+ * currently active or inactive.
1391
1638
  */
1392
- fragile_goods?: boolean;
1639
+ stage: string;
1393
1640
  /**
1394
- * - Indicates if the courier partner
1395
- * handles restricted goods, as per regulatory guidelines.
1641
+ * - Describes the type of status updates
1642
+ * provided by the courier partner (e.g., real-time, periodic).
1396
1643
  */
1397
- restricted_goods?: boolean;
1644
+ status_updates?: string;
1398
1645
  /**
1399
- * - Denotes if the courier partner
1400
- * provides cold storage facilities for goods.
1646
+ * - Indicates if the Non-Delivery Report
1647
+ * (NDR) feature is supported by the courier partner.
1401
1648
  */
1402
- cold_storage_goods?: boolean;
1649
+ ndr_attempts?: number;
1403
1650
  /**
1404
- * - Indicates if the courier partner
1405
- * supports doorstep exchange services.
1651
+ * - Defines the maximum quantity
1652
+ * of items allowed in a quality check shipment.
1406
1653
  */
1407
- doorstep_exchange?: boolean;
1654
+ qc_shipment_item_quantity?: number;
1408
1655
  /**
1409
- * - Specifies if the courier partner
1410
- * offers doorstep return services.
1656
+ * - Defines the maximum
1657
+ * quantity of items allowed in a non-quality check shipment.
1411
1658
  */
1412
- doorstep_return?: boolean;
1659
+ non_qc_shipment_item_quantity?: number;
1660
+ feature: CourierPartnerSchemeFeatures;
1661
+ };
1662
+ /** @returns {GetCountries} */
1663
+ declare function GetCountries(): GetCountries;
1664
+ type GetCountries = {
1413
1665
  /**
1414
- * - Indicates if the courier partner
1415
- * provides product installation services upon delivery.
1666
+ * - A list of country objects containing
1667
+ * detailed information about each country.
1416
1668
  */
1417
- product_installation?: boolean;
1669
+ items: GetCountriesItems[];
1670
+ page: Page;
1671
+ };
1672
+ /** @returns {TATUpdateDetails} */
1673
+ declare function TATUpdateDetails(): TATUpdateDetails;
1674
+ type TATUpdateDetails = {
1418
1675
  /**
1419
- * - Specifies whether the courier
1420
- * partner supports open-box delivery, allowing customers to inspect goods
1421
- * before accepting.
1676
+ * - Maximum time required for delivery
1677
+ * from the origin to the destination in seconds.
1678
+ */
1679
+ max_delivery_time?: number;
1680
+ /**
1681
+ * - Minimum time required for delivery
1682
+ * from the origin to the destination in seconds.
1422
1683
  */
1423
- openbox_delivery?: boolean;
1684
+ min_delivery_time?: number;
1685
+ forward?: TATDetails;
1686
+ reverse?: TATDetails;
1687
+ };
1688
+ /** @returns {StandardError} */
1689
+ declare function StandardError(): StandardError;
1690
+ type StandardError = {
1424
1691
  /**
1425
- * - Describes the type of status updates
1426
- * provided by the courier partner (e.g., real-time, periodic).
1692
+ * - A brief description of the error.
1427
1693
  */
1428
- status_updates?: string;
1694
+ message: string;
1695
+ };
1696
+ /** @returns {ValidationErrors} */
1697
+ declare function ValidationErrors(): ValidationErrors;
1698
+ type ValidationErrors = {
1699
+ errors: ValidationError[];
1700
+ };
1701
+ /** @returns {CreatedBy} */
1702
+ declare function CreatedBy(): CreatedBy;
1703
+ type CreatedBy = {
1429
1704
  /**
1430
- * - Indicates if the courier
1431
- * partner supports multiple pickups to a single drop location.
1705
+ * - Identifier of the user or system that created the object.
1432
1706
  */
1433
- multi_pick_single_drop?: boolean;
1707
+ id?: string;
1708
+ };
1709
+ /** @returns {ModifiedBy} */
1710
+ declare function ModifiedBy(): ModifiedBy;
1711
+ type ModifiedBy = {
1434
1712
  /**
1435
- * - Indicates whether the courier
1436
- * partner supports single pickup to multiple drop locations.
1713
+ * - Identifier of the user or system that created the object.
1437
1714
  */
1438
- single_pick_multi_drop?: boolean;
1715
+ id?: string;
1716
+ };
1717
+ /** @returns {ArithmeticOperations} */
1718
+ declare function ArithmeticOperations(): ArithmeticOperations;
1719
+ type ArithmeticOperations = {
1439
1720
  /**
1440
- * - Denotes if the courier partner
1441
- * offers services for multiple pickups to multiple drop locations.
1721
+ * - Specifies a less than operation, comparing values
1722
+ * smaller than the provided value.
1442
1723
  */
1443
- multi_pick_multi_drop?: boolean;
1724
+ lt?: number;
1444
1725
  /**
1445
- * - Specifies if the courier partner requires or
1446
- * supports the generation of e-waybills for shipments.
1726
+ * - Specifies a greater than operation, comparing
1727
+ * values larger than the provided value.
1447
1728
  */
1448
- ewaybill?: boolean;
1729
+ gt?: number;
1449
1730
  /**
1450
- * - Defines the maximum quantity
1451
- * of items allowed in a quality check shipment.
1731
+ * - Specifies a less than or equal to operation,
1732
+ * comparing values smaller than or equal to the provided value.
1452
1733
  */
1453
- qc_shipment_item_quantity?: number;
1734
+ lte?: number;
1454
1735
  /**
1455
- * - Defines the maximum
1456
- * quantity of items allowed in a non-quality check shipment.
1736
+ * - Specifies a greater than or equal to operation,
1737
+ * comparing values larger than or equal to the provided value.
1457
1738
  */
1458
- non_qc_shipment_item_quantity?: number;
1739
+ gte?: number;
1459
1740
  };
1460
- /** @returns {CourierPartnerSchemeV2Features} */
1461
- declare function CourierPartnerSchemeV2Features(): CourierPartnerSchemeV2Features;
1462
- type CourierPartnerSchemeV2Features = {
1741
+ /** @returns {CourierPartnerSchemeFeatures} */
1742
+ declare function CourierPartnerSchemeFeatures(): CourierPartnerSchemeFeatures;
1743
+ type CourierPartnerSchemeFeatures = {
1463
1744
  /**
1464
1745
  * - Indicates if the courier partner offers
1465
1746
  * doorstep quality check services.
@@ -1480,6 +1761,11 @@ type CourierPartnerSchemeV2Features = {
1480
1761
  * feature is supported by the courier partner.
1481
1762
  */
1482
1763
  ndr?: boolean;
1764
+ /**
1765
+ * - Number of attempts allowed for resolving
1766
+ * Non-Delivery Reports (NDR).
1767
+ */
1768
+ ndr_attempts?: number;
1483
1769
  /**
1484
1770
  * - Specifies if the courier partner
1485
1771
  * handles the transportation of dangerous goods.
@@ -1521,6 +1807,11 @@ type CourierPartnerSchemeV2Features = {
1521
1807
  * before accepting.
1522
1808
  */
1523
1809
  openbox_delivery?: boolean;
1810
+ /**
1811
+ * - Describes the type of status updates
1812
+ * provided by the courier partner (e.g., real-time, periodic).
1813
+ */
1814
+ status_updates?: string;
1524
1815
  /**
1525
1816
  * - Indicates if the courier
1526
1817
  * partner supports multiple pickups to a single drop location.
@@ -1541,59 +1832,6 @@ type CourierPartnerSchemeV2Features = {
1541
1832
  * supports the generation of e-waybills for shipments.
1542
1833
  */
1543
1834
  ewaybill?: boolean;
1544
- };
1545
- /** @returns {CourierPartnerSchemeV2DetailsModel} */
1546
- declare function CourierPartnerSchemeV2DetailsModel(): CourierPartnerSchemeV2DetailsModel;
1547
- type CourierPartnerSchemeV2DetailsModel = {
1548
- /**
1549
- * - Unique identifier of courier partner extension.
1550
- */
1551
- extension_id: string;
1552
- /**
1553
- * - Unique identifier of courier partner scheme.
1554
- */
1555
- scheme_id?: string;
1556
- /**
1557
- * - Name of the scheme.
1558
- */
1559
- name: string;
1560
- weight: ArithmeticOperations;
1561
- volumetric_weight?: ArithmeticOperations;
1562
- /**
1563
- * - Mode of transport associated with the
1564
- * courier partner scheme.
1565
- */
1566
- transport_type: string;
1567
- /**
1568
- * - Serviceable region associated with the courier
1569
- * partner scheme.
1570
- */
1571
- region: string;
1572
- /**
1573
- * - Type of delivery associated with the
1574
- * courier partner scheme.
1575
- */
1576
- delivery_type: string;
1577
- /**
1578
- * - Mode of payment associated with the
1579
- * courier partner scheme.
1580
- */
1581
- payment_mode: string[];
1582
- /**
1583
- * - Indicates if the courier partner scheme is
1584
- * currently active or inactive.
1585
- */
1586
- stage: string;
1587
- /**
1588
- * - Describes the type of status updates
1589
- * provided by the courier partner (e.g., real-time, periodic).
1590
- */
1591
- status_updates?: string;
1592
- /**
1593
- * - Indicates if the Non-Delivery Report
1594
- * (NDR) feature is supported by the courier partner.
1595
- */
1596
- ndr_attempts?: number;
1597
1835
  /**
1598
1836
  * - Defines the maximum quantity
1599
1837
  * of items allowed in a quality check shipment.
@@ -1604,232 +1842,216 @@ type CourierPartnerSchemeV2DetailsModel = {
1604
1842
  * quantity of items allowed in a non-quality check shipment.
1605
1843
  */
1606
1844
  non_qc_shipment_item_quantity?: number;
1607
- feature: CourierPartnerSchemeV2Features;
1608
1845
  };
1609
- /** @returns {CourierPartnerV2SchemeModel} */
1610
- declare function CourierPartnerV2SchemeModel(): CourierPartnerV2SchemeModel;
1611
- type CourierPartnerV2SchemeModel = {
1846
+ /** @returns {Error} */
1847
+ declare function Error(): Error;
1848
+ type Error = {
1612
1849
  /**
1613
- * - Unique identifier of courier partner extension.
1850
+ * - The type of the error.
1614
1851
  */
1615
- extension_id: string;
1852
+ type?: string;
1616
1853
  /**
1617
- * - Unique identifier of courier partner scheme.
1854
+ * - The value associated with the error.
1618
1855
  */
1619
- scheme_id: string;
1856
+ value?: string;
1620
1857
  /**
1621
- * - Unique identifier of company.
1858
+ * - The error message describing the issue.
1622
1859
  */
1623
- company_id?: string;
1860
+ message?: string;
1861
+ };
1862
+ /** @returns {Page} */
1863
+ declare function Page(): Page;
1864
+ type Page = {
1624
1865
  /**
1625
- * - Name of the scheme.
1866
+ * - The total number of items on the page.
1626
1867
  */
1627
- name: string;
1628
- weight: ArithmeticOperations;
1629
- volumetric_weight?: ArithmeticOperations;
1868
+ item_total?: number;
1630
1869
  /**
1631
- * - Mode of transport associated with the
1632
- * courier partner scheme.
1870
+ * - The identifier for the next page.
1633
1871
  */
1634
- transport_type: string;
1872
+ next_id?: string;
1635
1873
  /**
1636
- * - Serviceable region associated with the courier
1637
- * partner scheme.
1874
+ * - Indicates whether there is a previous page.
1638
1875
  */
1639
- region: string;
1876
+ has_previous?: boolean;
1640
1877
  /**
1641
- * - Type of delivery associated with the
1642
- * courier partner scheme.
1878
+ * - Indicates whether there is a next page.
1643
1879
  */
1644
- delivery_type: string;
1880
+ has_next?: boolean;
1645
1881
  /**
1646
- * - Mode of payment associated with the
1647
- * courier partner scheme.
1882
+ * - The current page number.
1648
1883
  */
1649
- payment_mode: string[];
1884
+ current?: number;
1650
1885
  /**
1651
- * - Indicates if the courier partner scheme is
1652
- * currently active or inactive.
1886
+ * - The type of the page, such as 'PageType'.
1653
1887
  */
1654
- stage: string;
1888
+ type: string;
1655
1889
  /**
1656
- * - Describes the type of status updates
1657
- * provided by the courier partner (e.g., real-time, periodic).
1890
+ * - The number of items per page.
1658
1891
  */
1659
- status_updates?: string;
1892
+ size?: number;
1660
1893
  /**
1661
- * - Indicates if the Non-Delivery Report
1662
- * (NDR) feature is supported by the courier partner.
1894
+ * - The number of items per page.
1663
1895
  */
1664
- ndr_attempts?: number;
1896
+ page_size?: number;
1897
+ };
1898
+ /** @returns {TATDetails} */
1899
+ declare function TATDetails(): TATDetails;
1900
+ type TATDetails = {
1665
1901
  /**
1666
- * - Defines the maximum quantity
1667
- * of items allowed in a quality check shipment.
1902
+ * - Maximum time required for delivery
1903
+ * from the origin to the destination in seconds.
1668
1904
  */
1669
- qc_shipment_item_quantity?: number;
1905
+ max_delivery_time?: number;
1670
1906
  /**
1671
- * - Defines the maximum
1672
- * quantity of items allowed in a non-quality check shipment.
1907
+ * - Minimum time required for delivery
1908
+ * from the origin to the destination in seconds.
1673
1909
  */
1674
- non_qc_shipment_item_quantity?: number;
1675
- feature: CourierPartnerSchemeV2Features;
1910
+ min_delivery_time?: number;
1676
1911
  };
1677
- /** @returns {courierPartnerSchemeV2List} */
1678
- declare function courierPartnerSchemeV2List(): courierPartnerSchemeV2List;
1679
- type courierPartnerSchemeV2List = {
1912
+ /** @returns {CourierPartnerSchemeModel} */
1913
+ declare function CourierPartnerSchemeModel(): CourierPartnerSchemeModel;
1914
+ type CourierPartnerSchemeModel = {
1680
1915
  /**
1681
- * - List of courier partner schemes
1916
+ * - Unique identifier of courier partner extension.
1682
1917
  */
1683
- items: CourierPartnerV2SchemeModel[];
1684
- page: Page;
1685
- };
1686
- /** @returns {ArithmeticOperations} */
1687
- declare function ArithmeticOperations(): ArithmeticOperations;
1688
- type ArithmeticOperations = {
1689
- lt?: number;
1690
- gt?: number;
1691
- lte?: number;
1692
- gte?: number;
1693
- };
1694
- /** @returns {CourierPartnerSchemeV2UpdateDetails} */
1695
- declare function CourierPartnerSchemeV2UpdateDetails(): CourierPartnerSchemeV2UpdateDetails;
1696
- type CourierPartnerSchemeV2UpdateDetails = {
1918
+ extension_id: string;
1697
1919
  /**
1698
- * - Name of the scheme.
1920
+ * - A string representing the unique identifier
1921
+ * for the scheme. This is a required field.
1922
+ */
1923
+ scheme_id: string;
1924
+ /**
1925
+ * - A string that specifies the name of the scheme.
1926
+ * This is a required field.
1699
1927
  */
1700
1928
  name: string;
1701
1929
  weight: ArithmeticOperations;
1702
1930
  volumetric_weight?: ArithmeticOperations;
1703
1931
  /**
1704
- * - Mode of transport associated with the
1705
- * courier partner scheme.
1932
+ * - A string that specifies the type of transport.
1706
1933
  */
1707
1934
  transport_type: string;
1708
1935
  /**
1709
- * - Serviceable region associated with the courier
1710
- * partner scheme.
1936
+ * - A string that indicates the region type.
1711
1937
  */
1712
1938
  region: string;
1713
1939
  /**
1714
- * - Type of delivery associated with the
1715
- * courier partner scheme.
1940
+ * - A string that defines the delivery type.
1716
1941
  */
1717
1942
  delivery_type: string;
1718
1943
  /**
1719
- * - Mode of payment associated with the
1720
- * courier partner scheme.
1944
+ * - An array of strings specifying the
1945
+ * payment modes available.
1721
1946
  */
1722
1947
  payment_mode: string[];
1723
1948
  /**
1724
- * - Indicates if the courier partner scheme is
1725
- * currently active or inactive.
1949
+ * - A string indicating the current stage of the scheme.
1726
1950
  */
1727
1951
  stage: string;
1728
- /**
1729
- * - Describes the type of status updates
1730
- * provided by the courier partner (e.g., real-time, periodic).
1731
- */
1732
- status_updates?: string;
1733
- /**
1734
- * - Indicates if the Non-Delivery Report
1735
- * (NDR) feature is supported by the courier partner.
1736
- */
1737
- ndr_attempts?: number;
1738
- /**
1739
- * - Defines the maximum quantity
1740
- * of items allowed in a quality check shipment.
1741
- */
1742
- qc_shipment_item_quantity?: number;
1743
- /**
1744
- * - Defines the maximum
1745
- * quantity of items allowed in a non-quality check shipment.
1746
- */
1747
- non_qc_shipment_item_quantity?: number;
1748
- feature: CourierPartnerSchemeV2Features;
1749
- };
1750
- /** @returns {GetCountries} */
1751
- declare function GetCountries(): GetCountries;
1752
- type GetCountries = {
1753
- items: GetCountriesItems[];
1754
- page: Page;
1952
+ feature: CourierPartnerSchemeFeatures;
1755
1953
  };
1756
1954
  /** @returns {GetCountriesItems} */
1757
1955
  declare function GetCountriesItems(): GetCountriesItems;
1758
1956
  type GetCountriesItems = {
1759
1957
  /**
1760
- * - Unique identifier of the country.
1958
+ * - A string serving as the unique identifier.
1761
1959
  */
1762
1960
  id?: string;
1763
1961
  /**
1764
- * - Name of the country.
1962
+ * - A category for classifying the country into a
1963
+ * specific subtype.
1964
+ */
1965
+ sub_type?: string;
1966
+ /**
1967
+ * - A globally unique identifier for the country.
1968
+ */
1969
+ uid?: string;
1970
+ /**
1971
+ * - The official or widely recognized name of the
1972
+ * country used in general contexts.
1765
1973
  */
1766
1974
  name?: string;
1767
1975
  /**
1768
- * - Two-letter ISO code representing the country.
1976
+ * - The 2-letter ISO code for the country.
1769
1977
  */
1770
1978
  iso2?: string;
1771
1979
  /**
1772
- * - Three-letter ISO code representing the country.
1980
+ * - The 3-letter ISO code for the country.
1773
1981
  */
1774
1982
  iso3?: string;
1775
1983
  /**
1776
- * - List of time zones used in the country
1777
- * (e.g., ["America/New_York", "America/Los_Angeles"]).
1984
+ * - A list of timezones associated with the country.
1778
1985
  */
1779
1986
  timezones?: string[];
1780
1987
  /**
1781
- * - Levels within the country (e.g.,
1782
- * states, cities) and their slugs (e.g., [{"name": "State", "slug": "state"},
1783
- * {"name": "City", "slug": "city"}]).
1988
+ * - A hierarchical list of items
1989
+ * representing organizational levels within the country.
1784
1990
  */
1785
1991
  hierarchy?: HierarchyItems[];
1786
1992
  /**
1787
- * - International dialing code for the country
1788
- * (e.g., "+1").
1993
+ * - A country-specific phone code.
1789
1994
  */
1790
1995
  phone_code?: string;
1996
+ currency?: CurrencyObject;
1791
1997
  /**
1792
- * - Indicates currency for the country (e.g., "INR").
1793
- */
1794
- currency?: string;
1795
- /**
1796
- * - Indicates the type of object (e.g., "country").
1998
+ * - The type or classification of the country (e.g.,
1999
+ * sovereign or dependent).
1797
2000
  */
1798
2001
  type?: string;
1799
2002
  /**
1800
- * - Geographical latitude of the country (e.g., "37.0902").
2003
+ * - The latitude of the central point of the country.
1801
2004
  */
1802
2005
  latitude?: string;
1803
2006
  /**
1804
- * - Geographical longitude of the country (e.g.,
1805
- * "-95.7129").
2007
+ * - The longitude of the central point of the country.
1806
2008
  */
1807
2009
  longitude?: string;
1808
2010
  /**
1809
- * - User-friendly version of the geographical
1810
- * data, which may be more descriptive or formatted differently.
2011
+ * - A user-friendly name for the country,
2012
+ * typically for display purposes.
1811
2013
  */
1812
2014
  display_name?: string;
1813
2015
  /**
1814
- * - More detailed hierarchical data is
1815
- * available, meaning states, cities, or other regions within the country have
1816
- * been populated in the system.
2016
+ * - A boolean indicating whether
2017
+ * additional hierarchical regions or divisions are present.
1817
2018
  */
1818
2019
  has_next_hierarchy?: boolean;
1819
2020
  };
1820
2021
  /** @returns {HierarchyItems} */
1821
2022
  declare function HierarchyItems(): HierarchyItems;
1822
2023
  type HierarchyItems = {
2024
+ /**
2025
+ * - The name of the item as displayed to the user,
2026
+ * usually in a UI or listing.
2027
+ */
2028
+ name?: string;
1823
2029
  /**
1824
2030
  * - It represent a country display name.
1825
2031
  */
1826
2032
  display_name?: string;
1827
2033
  /**
1828
- * - A URL-friendly version of the name, often used
1829
- * for referencing or querying purposes.
2034
+ * - A slug is a human-readable URL segment, typically
2035
+ * generated from a title with special characters removed.
1830
2036
  */
1831
2037
  slug?: string;
1832
2038
  };
2039
+ /** @returns {CurrencyObject} */
2040
+ declare function CurrencyObject(): CurrencyObject;
2041
+ type CurrencyObject = {
2042
+ /**
2043
+ * - A string representing the currency code.
2044
+ */
2045
+ code?: string;
2046
+ /**
2047
+ * - A string representing the currency name.
2048
+ */
2049
+ name?: string;
2050
+ /**
2051
+ * - A string representing the currency symbol.
2052
+ */
2053
+ symbol?: string;
2054
+ };
1833
2055
  /** @returns {ValidationError} */
1834
2056
  declare function ValidationError(): ValidationError;
1835
2057
  type ValidationError = {
@@ -1842,11 +2064,3 @@ type ValidationError = {
1842
2064
  */
1843
2065
  field: string;
1844
2066
  };
1845
- /** @returns {StandardError} */
1846
- declare function StandardError(): StandardError;
1847
- type StandardError = {
1848
- /**
1849
- * - A brief description of the error.
1850
- */
1851
- message: string;
1852
- };