@gofynd/fdk-client-javascript 3.14.0 → 3.16.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.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Order/OrderApplicationClient.d.ts +11 -1
- package/sdk/application/Order/OrderApplicationClient.js +50 -1
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +0 -20
- package/sdk/application/Payment/PaymentApplicationClient.js +0 -77
- package/sdk/common/Constant.d.ts +13 -4
- package/sdk/common/Constant.js +17 -6
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +2 -2
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +1 -1
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +5 -4
- package/sdk/partner/Theme/ThemePartnerModel.js +9 -6
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +1 -1
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +2 -2
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +10 -0
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +95 -0
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +47 -1
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +29 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +17 -3
- package/sdk/platform/Cart/CartPlatformModel.js +14 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +13 -16
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +17 -20
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +10 -11
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1 -1
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +63 -41
- package/sdk/platform/Catalog/CatalogPlatformModel.js +42 -34
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +2 -2
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +2 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +2 -2
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +1 -1
- package/sdk/platform/Content/ContentPlatformModel.d.ts +7 -6
- package/sdk/platform/Content/ContentPlatformModel.js +10 -7
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.js +1 -1
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
- package/sdk/platform/Order/OrderPlatformModel.d.ts +2 -2
- package/sdk/platform/Order/OrderPlatformModel.js +1 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +0 -23
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +0 -161
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +1 -19
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +0 -24
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +1 -159
- package/sdk/platform/Payment/PaymentPlatformModel.js +0 -112
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.js +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +67 -49
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +45 -42
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformModel.js +1 -1
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +5 -4
- package/sdk/platform/Theme/ThemePlatformModel.js +9 -6
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +3 -2
- package/sdk/platform/User/UserPlatformApplicationClient.js +5 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +0 -1
- package/sdk/platform/User/UserPlatformModel.d.ts +17 -1
- package/sdk/platform/User/UserPlatformModel.js +15 -0
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +2 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +1 -1
|
@@ -176,17 +176,11 @@ const Joi = require("joi");
|
|
|
176
176
|
* @typedef PaymentFlow
|
|
177
177
|
* @property {AggregatorRoute} [bqr_razorpay]
|
|
178
178
|
* @property {AggregatorRoute} [fynd]
|
|
179
|
-
* @property {AggregatorRoute} [epaylater]
|
|
180
179
|
* @property {AggregatorRoute} [razorpay]
|
|
181
180
|
* @property {AggregatorRoute} [juspay]
|
|
182
|
-
* @property {AggregatorRoute} [ajiodhan]
|
|
183
181
|
* @property {AggregatorRoute} [simpl]
|
|
184
|
-
* @property {AggregatorRoute} [rupifi]
|
|
185
|
-
* @property {AggregatorRoute} [mswipe]
|
|
186
|
-
* @property {AggregatorRoute} [stripe]
|
|
187
182
|
* @property {AggregatorRoute} [ccavenue]
|
|
188
183
|
* @property {AggregatorRoute} [payubiz]
|
|
189
|
-
* @property {AggregatorRoute} [jiopay]
|
|
190
184
|
*/
|
|
191
185
|
|
|
192
186
|
/**
|
|
@@ -671,50 +665,6 @@ const Joi = require("joi");
|
|
|
671
665
|
* @property {boolean} success - Response is successful or not
|
|
672
666
|
*/
|
|
673
667
|
|
|
674
|
-
/**
|
|
675
|
-
* @typedef RepaymentRequestDetails
|
|
676
|
-
* @property {string} fwd_shipment_id - Purchase Shipment Id
|
|
677
|
-
* @property {string} aggregator - Name of Payment Gateway
|
|
678
|
-
* @property {string} current_status - Status
|
|
679
|
-
* @property {string} merchant_order_id - Merchant's Order Id
|
|
680
|
-
* @property {number} amount - Amount to paid back
|
|
681
|
-
* @property {string} payment_mode - Payment Mode
|
|
682
|
-
* @property {number} outstanding_details_id - Outstanding details ID
|
|
683
|
-
* @property {string} aggregator_transaction_id - Unique Id for the transaction
|
|
684
|
-
* @property {string} aggregator_order_id - Id of payment gateway
|
|
685
|
-
* @property {string} payment_mode_identifier - Payment Mode Id
|
|
686
|
-
*/
|
|
687
|
-
|
|
688
|
-
/**
|
|
689
|
-
* @typedef RepaymentDetailsSerialiserPayAll
|
|
690
|
-
* @property {number} total_amount - Total amount
|
|
691
|
-
* @property {string} extension_order_id - Order id created in extension
|
|
692
|
-
* @property {string} aggregator_transaction_id - Unique Id for the transaction
|
|
693
|
-
* @property {string} aggregator_order_id - Id of payment gateway
|
|
694
|
-
* @property {RepaymentRequestDetails[]} [shipment_details]
|
|
695
|
-
*/
|
|
696
|
-
|
|
697
|
-
/**
|
|
698
|
-
* @typedef RepaymentDetails
|
|
699
|
-
* @property {Object} data
|
|
700
|
-
* @property {boolean} success - Success/Failure of the transaction
|
|
701
|
-
*/
|
|
702
|
-
|
|
703
|
-
/**
|
|
704
|
-
* @typedef MerchantOnBoardingCreation
|
|
705
|
-
* @property {string} credit_line_id - Merchant ID at Ajiodhan's end
|
|
706
|
-
* @property {string} aggregator - Payment aggregator name
|
|
707
|
-
* @property {string} app_id - Application id
|
|
708
|
-
* @property {string} user_id - Deadlock or Grimlock user id
|
|
709
|
-
* @property {string} status - Status
|
|
710
|
-
*/
|
|
711
|
-
|
|
712
|
-
/**
|
|
713
|
-
* @typedef MerchantOnBoardingDetails
|
|
714
|
-
* @property {Object} data
|
|
715
|
-
* @property {boolean} success - Success/Failure of the transaction
|
|
716
|
-
*/
|
|
717
|
-
|
|
718
668
|
/**
|
|
719
669
|
* @typedef ValidateCustomerCreation
|
|
720
670
|
* @property {string} phone_number - User mobile number without country code.
|
|
@@ -1557,17 +1507,11 @@ class PaymentPlatformModel {
|
|
|
1557
1507
|
return Joi.object({
|
|
1558
1508
|
bqr_razorpay: PaymentPlatformModel.AggregatorRoute(),
|
|
1559
1509
|
fynd: PaymentPlatformModel.AggregatorRoute(),
|
|
1560
|
-
epaylater: PaymentPlatformModel.AggregatorRoute(),
|
|
1561
1510
|
razorpay: PaymentPlatformModel.AggregatorRoute(),
|
|
1562
1511
|
juspay: PaymentPlatformModel.AggregatorRoute(),
|
|
1563
|
-
ajiodhan: PaymentPlatformModel.AggregatorRoute(),
|
|
1564
1512
|
simpl: PaymentPlatformModel.AggregatorRoute(),
|
|
1565
|
-
rupifi: PaymentPlatformModel.AggregatorRoute(),
|
|
1566
|
-
mswipe: PaymentPlatformModel.AggregatorRoute(),
|
|
1567
|
-
stripe: PaymentPlatformModel.AggregatorRoute(),
|
|
1568
1513
|
ccavenue: PaymentPlatformModel.AggregatorRoute(),
|
|
1569
1514
|
payubiz: PaymentPlatformModel.AggregatorRoute(),
|
|
1570
|
-
jiopay: PaymentPlatformModel.AggregatorRoute(),
|
|
1571
1515
|
});
|
|
1572
1516
|
}
|
|
1573
1517
|
|
|
@@ -2172,62 +2116,6 @@ class PaymentPlatformModel {
|
|
|
2172
2116
|
});
|
|
2173
2117
|
}
|
|
2174
2118
|
|
|
2175
|
-
/** @returns {RepaymentRequestDetails} */
|
|
2176
|
-
static RepaymentRequestDetails() {
|
|
2177
|
-
return Joi.object({
|
|
2178
|
-
fwd_shipment_id: Joi.string().allow("").required(),
|
|
2179
|
-
aggregator: Joi.string().allow("").required(),
|
|
2180
|
-
current_status: Joi.string().allow("").required(),
|
|
2181
|
-
merchant_order_id: Joi.string().allow("").required(),
|
|
2182
|
-
amount: Joi.number().required(),
|
|
2183
|
-
payment_mode: Joi.string().allow("").required(),
|
|
2184
|
-
outstanding_details_id: Joi.number().required(),
|
|
2185
|
-
aggregator_transaction_id: Joi.string().allow("").required(),
|
|
2186
|
-
aggregator_order_id: Joi.string().allow("").required(),
|
|
2187
|
-
payment_mode_identifier: Joi.string().allow("").required(),
|
|
2188
|
-
});
|
|
2189
|
-
}
|
|
2190
|
-
|
|
2191
|
-
/** @returns {RepaymentDetailsSerialiserPayAll} */
|
|
2192
|
-
static RepaymentDetailsSerialiserPayAll() {
|
|
2193
|
-
return Joi.object({
|
|
2194
|
-
total_amount: Joi.number().required(),
|
|
2195
|
-
extension_order_id: Joi.string().allow("").required(),
|
|
2196
|
-
aggregator_transaction_id: Joi.string().allow("").required(),
|
|
2197
|
-
aggregator_order_id: Joi.string().allow("").required(),
|
|
2198
|
-
shipment_details: Joi.array().items(
|
|
2199
|
-
PaymentPlatformModel.RepaymentRequestDetails()
|
|
2200
|
-
),
|
|
2201
|
-
});
|
|
2202
|
-
}
|
|
2203
|
-
|
|
2204
|
-
/** @returns {RepaymentDetails} */
|
|
2205
|
-
static RepaymentDetails() {
|
|
2206
|
-
return Joi.object({
|
|
2207
|
-
data: Joi.object().pattern(/\S/, Joi.any()).required(),
|
|
2208
|
-
success: Joi.boolean().required(),
|
|
2209
|
-
});
|
|
2210
|
-
}
|
|
2211
|
-
|
|
2212
|
-
/** @returns {MerchantOnBoardingCreation} */
|
|
2213
|
-
static MerchantOnBoardingCreation() {
|
|
2214
|
-
return Joi.object({
|
|
2215
|
-
credit_line_id: Joi.string().allow("").required(),
|
|
2216
|
-
aggregator: Joi.string().allow("").required(),
|
|
2217
|
-
app_id: Joi.string().allow("").required(),
|
|
2218
|
-
user_id: Joi.string().allow("").required(),
|
|
2219
|
-
status: Joi.string().allow("").required(),
|
|
2220
|
-
});
|
|
2221
|
-
}
|
|
2222
|
-
|
|
2223
|
-
/** @returns {MerchantOnBoardingDetails} */
|
|
2224
|
-
static MerchantOnBoardingDetails() {
|
|
2225
|
-
return Joi.object({
|
|
2226
|
-
data: Joi.object().pattern(/\S/, Joi.any()).required(),
|
|
2227
|
-
success: Joi.boolean().required(),
|
|
2228
|
-
});
|
|
2229
|
-
}
|
|
2230
|
-
|
|
2231
2119
|
/** @returns {ValidateCustomerCreation} */
|
|
2232
2120
|
static ValidateCustomerCreation() {
|
|
2233
2121
|
return Joi.object({
|
|
@@ -55,7 +55,7 @@ export = RewardsPlatformModel;
|
|
|
55
55
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
56
56
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
57
57
|
* @property {number} [current] - The current page number.
|
|
58
|
-
* @property {string} type - The type of the page,
|
|
58
|
+
* @property {string} type - The type of the page, can be 'cursor' or 'number'.
|
|
59
59
|
* @property {number} [size] - The number of items per page.
|
|
60
60
|
* @property {number} [page_size] - The number of items per page.
|
|
61
61
|
*/
|
|
@@ -248,7 +248,7 @@ type Page = {
|
|
|
248
248
|
*/
|
|
249
249
|
current?: number;
|
|
250
250
|
/**
|
|
251
|
-
* - The type of the page,
|
|
251
|
+
* - The type of the page, can be 'cursor' or 'number'.
|
|
252
252
|
*/
|
|
253
253
|
type: string;
|
|
254
254
|
/**
|
|
@@ -63,7 +63,7 @@ const Joi = require("joi");
|
|
|
63
63
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
64
64
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
65
65
|
* @property {number} [current] - The current page number.
|
|
66
|
-
* @property {string} type - The type of the page,
|
|
66
|
+
* @property {string} type - The type of the page, can be 'cursor' or 'number'.
|
|
67
67
|
* @property {number} [size] - The number of items per page.
|
|
68
68
|
* @property {number} [page_size] - The number of items per page.
|
|
69
69
|
*/
|
|
@@ -31,7 +31,8 @@ export = ServiceabilityPlatformModel;
|
|
|
31
31
|
* @property {boolean} [is_default] - Whether this is the default fulfillment option.
|
|
32
32
|
* @property {string} [type] - Type of fulfillment option.
|
|
33
33
|
* @property {string} [status] - Status of the fulfillment option.
|
|
34
|
-
* @property {BusinessUnit[]} [business_unit]
|
|
34
|
+
* @property {BusinessUnit[]} [business_unit] - Name of the ordering-channel or
|
|
35
|
+
* business, e.g. storefront, storeos.
|
|
35
36
|
* @property {FulfillmentStores} [fulfillment_stores]
|
|
36
37
|
* @property {FulfillmentProducts} [products]
|
|
37
38
|
* @property {CourierPartnerSchemes} [cp_schemes]
|
|
@@ -266,13 +267,13 @@ export = ServiceabilityPlatformModel;
|
|
|
266
267
|
* @typedef PincodeMopBulkError
|
|
267
268
|
* @property {string} [batch_id] - A unique identifier for the performed batch operation.
|
|
268
269
|
* @property {number} [status_code] - Status code for the error.
|
|
269
|
-
* @property {
|
|
270
|
+
* @property {Error[]} [error] - An array containing error details.
|
|
270
271
|
* @property {boolean} [success] - Whether operation was successful.
|
|
271
272
|
*/
|
|
272
273
|
/**
|
|
273
274
|
* @typedef CommonError
|
|
274
275
|
* @property {number} [status_code] - Status code for the error.
|
|
275
|
-
* @property {
|
|
276
|
+
* @property {Error[]} [error] - An array containing error details.
|
|
276
277
|
* @property {boolean} [success] - Whether operation was successful.
|
|
277
278
|
*/
|
|
278
279
|
/**
|
|
@@ -491,8 +492,8 @@ export = ServiceabilityPlatformModel;
|
|
|
491
492
|
* @property {string} name - Name for the courier partner rule.
|
|
492
493
|
* @property {string[]} manual_priority - Has the list of courier partner
|
|
493
494
|
* account Ids that are to be given priority.
|
|
494
|
-
* @property {string} filters - Denotes weather specific filters are applied
|
|
495
|
-
* courier partner accounts or all accounts are considered.
|
|
495
|
+
* @property {string} [filters] - Denotes weather specific filters are applied
|
|
496
|
+
* to courier partner accounts or all accounts are considered.
|
|
496
497
|
* @property {CourierPartnerRuleConditions} conditions
|
|
497
498
|
* @property {string[]} sort - Sort Strategy for the courier partners.
|
|
498
499
|
* @property {string} [type] - Denotes the type of the rule.
|
|
@@ -1189,7 +1190,7 @@ export = ServiceabilityPlatformModel;
|
|
|
1189
1190
|
* @typedef PlatformLocationArticles
|
|
1190
1191
|
* @property {PlatformLocationArticle[]} articles - List of articles for this
|
|
1191
1192
|
* fulfillment location.
|
|
1192
|
-
* @property {number}
|
|
1193
|
+
* @property {number} fulfillment_location_id - Unique identifier for the
|
|
1193
1194
|
* fulfillment location.
|
|
1194
1195
|
* @property {string[]} [fulfillment_tags] - Tags associated with the
|
|
1195
1196
|
* fulfillment location.
|
|
@@ -1243,6 +1244,9 @@ export = ServiceabilityPlatformModel;
|
|
|
1243
1244
|
* fulfillment location.
|
|
1244
1245
|
* @property {ShipmentsCourierPartner[]} [courier_partners] - List of courier
|
|
1245
1246
|
* partners handling the shipment.
|
|
1247
|
+
* @property {number} [count] - The number of items in the shipment.
|
|
1248
|
+
* @property {boolean} [is_cod_available] - Flag indicating whether Cash on
|
|
1249
|
+
* Delivery (COD) is available for the shipment.
|
|
1246
1250
|
*/
|
|
1247
1251
|
/**
|
|
1248
1252
|
* @typedef Packaging
|
|
@@ -1529,7 +1533,7 @@ export = ServiceabilityPlatformModel;
|
|
|
1529
1533
|
* @property {boolean} [has_previous] - Indicates whether there is a previous page.
|
|
1530
1534
|
* @property {boolean} [has_next] - Indicates whether there is a next page.
|
|
1531
1535
|
* @property {number} [current] - The current page number.
|
|
1532
|
-
* @property {string} type - The type of the page,
|
|
1536
|
+
* @property {string} type - The type of the page, can be 'cursor' or 'number'.
|
|
1533
1537
|
* @property {number} [size] - The number of items per page.
|
|
1534
1538
|
* @property {number} [page_size] - The number of items per page.
|
|
1535
1539
|
*/
|
|
@@ -1592,8 +1596,8 @@ export = ServiceabilityPlatformModel;
|
|
|
1592
1596
|
* @property {ListViewProduct} product
|
|
1593
1597
|
* @property {number} company_id - The unique identifier of the company.
|
|
1594
1598
|
* @property {string} application_id - The unique identifier of the application.
|
|
1595
|
-
* @property {CreatedBy} created_by
|
|
1596
|
-
* @property {ModifiedBy} modified_by
|
|
1599
|
+
* @property {CreatedBy} [created_by]
|
|
1600
|
+
* @property {ModifiedBy} [modified_by]
|
|
1597
1601
|
* @property {string} created_on - The timestamp when the record was created.
|
|
1598
1602
|
* @property {string} modified_on - The timestamp when the record last modified.
|
|
1599
1603
|
* @property {string} [stage] - Current stage of the zone.
|
|
@@ -1750,7 +1754,7 @@ export = ServiceabilityPlatformModel;
|
|
|
1750
1754
|
* @property {StringComparisonOperations} [zone_ids]
|
|
1751
1755
|
* @property {IntComparisonOperations} [department_ids]
|
|
1752
1756
|
* @property {IntComparisonOperations} [brand_ids]
|
|
1753
|
-
* @property {
|
|
1757
|
+
* @property {DateOperations} [order_place_date]
|
|
1754
1758
|
* @property {IntComparisonOperations} [store_ids]
|
|
1755
1759
|
* @property {StringComparisonOperations} [store_type]
|
|
1756
1760
|
* @property {StringComparisonOperations} [store_tags]
|
|
@@ -1788,6 +1792,11 @@ export = ServiceabilityPlatformModel;
|
|
|
1788
1792
|
* @property {number[]} [includes] - Array of integer values to be included in
|
|
1789
1793
|
* the comparison.
|
|
1790
1794
|
*/
|
|
1795
|
+
/**
|
|
1796
|
+
* @typedef DateOperations
|
|
1797
|
+
* @property {string} lte - Less than or equal to condition for date.
|
|
1798
|
+
* @property {string} gte - Greater than or equal to condition for date.
|
|
1799
|
+
*/
|
|
1791
1800
|
/**
|
|
1792
1801
|
* @typedef ArithmeticOperations
|
|
1793
1802
|
* @property {number} [lt] - Specifies a less than operation, comparing values
|
|
@@ -2066,13 +2075,6 @@ export = ServiceabilityPlatformModel;
|
|
|
2066
2075
|
* @property {number} [gt] - The greater-than comparison value for the radius.
|
|
2067
2076
|
* @property {number} [gte] - The greater-than-or-equal comparison value for the radius.
|
|
2068
2077
|
*/
|
|
2069
|
-
/**
|
|
2070
|
-
* @typedef DateOperations
|
|
2071
|
-
* @property {string} [lt] - Less than condition for date.
|
|
2072
|
-
* @property {string} [gt] - Greater than condition for date.
|
|
2073
|
-
* @property {string} [lte] - Less than or equal to condition for date.
|
|
2074
|
-
* @property {string} [gte] - Greater than or equal to condition for date.
|
|
2075
|
-
*/
|
|
2076
2078
|
/**
|
|
2077
2079
|
* @typedef CourierPartnerSchemeModel
|
|
2078
2080
|
* @property {string} extension_id - Unique identifier of courier partner extension.
|
|
@@ -2318,7 +2320,8 @@ export = ServiceabilityPlatformModel;
|
|
|
2318
2320
|
*/
|
|
2319
2321
|
/**
|
|
2320
2322
|
* @typedef ApplicationFields
|
|
2321
|
-
* @property {GetCountryFieldsAddress[]} [address]
|
|
2323
|
+
* @property {GetCountryFieldsAddress[]} [address] - List of address-related
|
|
2324
|
+
* fields for the application.
|
|
2322
2325
|
* @property {string[]} [serviceability_fields] - An array of strings
|
|
2323
2326
|
* representing fields related to the serviceability of the country.
|
|
2324
2327
|
* @property {GetCountryFieldsAddressTemplateApplication} [address_template]
|
|
@@ -2484,7 +2487,7 @@ export = ServiceabilityPlatformModel;
|
|
|
2484
2487
|
declare class ServiceabilityPlatformModel {
|
|
2485
2488
|
}
|
|
2486
2489
|
declare namespace ServiceabilityPlatformModel {
|
|
2487
|
-
export { PlatformShipmentsRequestSchema, PlatformShipmentsResponseSchema, ShipmentsErrorResult, FulfillmentOption, FulfillmentOptionsList, FulfillmentOptionProducts, FulfillmentOptionStores, FulfillmentOptionBulkValidate, FulfillmentOptionBulkValidateData, FulfillmentOptionBulk, FulfillmentOptionBulkData, OperationResponseSchema, SelfshipSchema, ServiceabilityErrorResult, UpdateZoneData, ZoneUpdateSuccessResult, ServiceabilityDeleteErrorResult, ZoneDeleteSuccessResult, ListViewSchema, GetZoneByIdSchema, CommonErrorResult, CreateZoneDataSchema, ZoneBulkExport, GetZoneBulkExport, CreateBulkZoneData, ZoneSchema, CreateBulkZoneResult, BulkCreateZoneExport, PincodeMopData, PincodeMOPResult, PincodeMopUpdateAuditError, PincodeMopBulkError, CommonError, PincodeMopBulkData, PincodeBulkViewResult, PincodeCodStatusListingDetails, PincodeCodStatusListingResult, PincodeMopUpdateAuditHistoryDetails, PincodeMopUpdateAuditHistoryResultData, BulkGeoAreaDetails, BulkGeoAreaResult, BulkGeoAreaGetResult, GeoAreaBulkCreationResult, GeoAreaBulkExportResult, GeoAreaRequestBody, GeoAreaErrorResult, GeoAreaResponseBody, GeoAreaPutResponseBody, GeoAreaGetResponseBody, GeoAreaDetails, Error, CourierAccountDetailsBody, CourierPartnerRuleResult, CourierPartnerRule, BulkFailureResult, FailureResult, CourierPartnerRulesListResult, ShipmentCourierPartnerDetails, ShipmentCourierPartnerResult, CompanyConfig, ApplicationConfigPatch, ApplicationConfigPatchResult, BulkRegionJobDetails, BulkRegionResultItemData, BulkRegionResult, StoreRuleConfigData, StoreRuleDataSchema, GetStoreRulesApiResult, CreateStoreRuleDetailsSchema, StoreRuleResultSchema, StoreRuleUpdateResultSchema, CourierAccountResult, CompanyCourierPartnerAccountListResult, PackageMaterial, PackageMaterialNotFound, PackageMaterialsErrorResult, PackageMaterialResult, PackageRule, PackageRuleResult, PackagesListResult, PackageItem, RulePriorityDetails, RulePriorityResult, OptimalLocationsResult, OptimlLocationsRequestSchema, ValidationError, StandardError, CourierPartnerSchemeDetailsModel, CourierPartnerSchemeModelSchema, CourierPartnerSchemeUpdateDetailsSchema, CourierPartnerSchemeList, BulkRegionServiceabilityTatDetails, BulkRegionServiceabilityTatResultItemData, BulkRegionServiceabilityTatResult, GetCountries, GetLocalities, GetCountry, BulkImportLocalitiesDetails, BulkImportLocalitiesResult, BulkErrorResult, LocalitiesBulkExport, LocalitiesBulkExportFetch, LocalitiesErrorResult, GetLocality, ValidateAddress, ErrorResult, ApplicationConfigPut, ApplicationConfigPutDetail, ApplicationConfigGetResult, InstallCourierPartnerResponseSchema, GetLocalitiesBulkHistory, CompanyConfigurationSchema, PlatformLocationArticles, PlatformLocationArticle, ParentItemIdentifiers, PlatformShipmentsToServiceability, PlatformShipmentsSchema, Packaging, Dimension, FulfillmentOptionItem, ShipmentsPromise, CustomerPromise, ShipmentPromiseMeta, SellerPromise, CourierPartnerPromise, CourierPartnerAttributes, CourierPartnerTAT, CustomerInitialPromise, ShipmentsArticle, ShipmentDimension, ShipmentsMeta, ShipmentsCourierPartner, AreaCode, TAT, BusinessUnit, FulfillmentStores, FulfillmentProducts, CourierPartnerSchemes, CourierPartnerScheme, FulfillmentOptionProduct, NetQuantity, Trader, ProductPublish, TaxIdentifier, ReturnConfig, CustomOrder, Size, Identifier, Page, FulfillmentOptionStore, Address, FulfillmentOptionValidate, ProductSchema, StoresSchema, CreatedBy, ModifiedBy, ListViewItems, GeoArea, ListViewProduct, Summary, RegionSchema, ZoneStores, ZoneProduct, ZoneBulkItem, PincodeMopUpdateResult, PincodeCodStatusItem, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResult, Area, GeoAreaResponseDetail, GeoAreaItemResult, AreaExpanded, Country, Region, Page2, CourierPartnerRuleConditions, LocationRule, LocationRuleValues, StringComparisonOperations, IntComparisonOperations, ArithmeticOperations, CourierPartnerRuleCPListResult, CourierPartnerSchemeDefaultTat, CourierPartnerSchemeTat, CourierPartnerSchemeFeatures, CourierPartnerList, ShipmentsCourierPartnersServiceability, CPShipments, ShipmentsArticles, ArticleWeight, ArticleAttributes, ArticleDimension, ArticleSet, ArticleSizeDistribution, SetSize, ArticleDeliverySlots, ArticleReturnReason, CourierPartners, ShipmentCourierPartners, CourierPartnerConfig, BuyboxRuleConfig, PromiseConfig, StorePromiseAttributeConfig, DeliveryServiceAttributeConfig, BufferField, StorePrioritySchema, StoreRuleConditionSchema, CustomerRadiusSchema,
|
|
2490
|
+
export { PlatformShipmentsRequestSchema, PlatformShipmentsResponseSchema, ShipmentsErrorResult, FulfillmentOption, FulfillmentOptionsList, FulfillmentOptionProducts, FulfillmentOptionStores, FulfillmentOptionBulkValidate, FulfillmentOptionBulkValidateData, FulfillmentOptionBulk, FulfillmentOptionBulkData, OperationResponseSchema, SelfshipSchema, ServiceabilityErrorResult, UpdateZoneData, ZoneUpdateSuccessResult, ServiceabilityDeleteErrorResult, ZoneDeleteSuccessResult, ListViewSchema, GetZoneByIdSchema, CommonErrorResult, CreateZoneDataSchema, ZoneBulkExport, GetZoneBulkExport, CreateBulkZoneData, ZoneSchema, CreateBulkZoneResult, BulkCreateZoneExport, PincodeMopData, PincodeMOPResult, PincodeMopUpdateAuditError, PincodeMopBulkError, CommonError, PincodeMopBulkData, PincodeBulkViewResult, PincodeCodStatusListingDetails, PincodeCodStatusListingResult, PincodeMopUpdateAuditHistoryDetails, PincodeMopUpdateAuditHistoryResultData, BulkGeoAreaDetails, BulkGeoAreaResult, BulkGeoAreaGetResult, GeoAreaBulkCreationResult, GeoAreaBulkExportResult, GeoAreaRequestBody, GeoAreaErrorResult, GeoAreaResponseBody, GeoAreaPutResponseBody, GeoAreaGetResponseBody, GeoAreaDetails, Error, CourierAccountDetailsBody, CourierPartnerRuleResult, CourierPartnerRule, BulkFailureResult, FailureResult, CourierPartnerRulesListResult, ShipmentCourierPartnerDetails, ShipmentCourierPartnerResult, CompanyConfig, ApplicationConfigPatch, ApplicationConfigPatchResult, BulkRegionJobDetails, BulkRegionResultItemData, BulkRegionResult, StoreRuleConfigData, StoreRuleDataSchema, GetStoreRulesApiResult, CreateStoreRuleDetailsSchema, StoreRuleResultSchema, StoreRuleUpdateResultSchema, CourierAccountResult, CompanyCourierPartnerAccountListResult, PackageMaterial, PackageMaterialNotFound, PackageMaterialsErrorResult, PackageMaterialResult, PackageRule, PackageRuleResult, PackagesListResult, PackageItem, RulePriorityDetails, RulePriorityResult, OptimalLocationsResult, OptimlLocationsRequestSchema, ValidationError, StandardError, CourierPartnerSchemeDetailsModel, CourierPartnerSchemeModelSchema, CourierPartnerSchemeUpdateDetailsSchema, CourierPartnerSchemeList, BulkRegionServiceabilityTatDetails, BulkRegionServiceabilityTatResultItemData, BulkRegionServiceabilityTatResult, GetCountries, GetLocalities, GetCountry, BulkImportLocalitiesDetails, BulkImportLocalitiesResult, BulkErrorResult, LocalitiesBulkExport, LocalitiesBulkExportFetch, LocalitiesErrorResult, GetLocality, ValidateAddress, ErrorResult, ApplicationConfigPut, ApplicationConfigPutDetail, ApplicationConfigGetResult, InstallCourierPartnerResponseSchema, GetLocalitiesBulkHistory, CompanyConfigurationSchema, PlatformLocationArticles, PlatformLocationArticle, ParentItemIdentifiers, PlatformShipmentsToServiceability, PlatformShipmentsSchema, Packaging, Dimension, FulfillmentOptionItem, ShipmentsPromise, CustomerPromise, ShipmentPromiseMeta, SellerPromise, CourierPartnerPromise, CourierPartnerAttributes, CourierPartnerTAT, CustomerInitialPromise, ShipmentsArticle, ShipmentDimension, ShipmentsMeta, ShipmentsCourierPartner, AreaCode, TAT, BusinessUnit, FulfillmentStores, FulfillmentProducts, CourierPartnerSchemes, CourierPartnerScheme, FulfillmentOptionProduct, NetQuantity, Trader, ProductPublish, TaxIdentifier, ReturnConfig, CustomOrder, Size, Identifier, Page, FulfillmentOptionStore, Address, FulfillmentOptionValidate, ProductSchema, StoresSchema, CreatedBy, ModifiedBy, ListViewItems, GeoArea, ListViewProduct, Summary, RegionSchema, ZoneStores, ZoneProduct, ZoneBulkItem, PincodeMopUpdateResult, PincodeCodStatusItem, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResult, Area, GeoAreaResponseDetail, GeoAreaItemResult, AreaExpanded, Country, Region, Page2, CourierPartnerRuleConditions, LocationRule, LocationRuleValues, StringComparisonOperations, IntComparisonOperations, DateOperations, ArithmeticOperations, CourierPartnerRuleCPListResult, CourierPartnerSchemeDefaultTat, CourierPartnerSchemeTat, CourierPartnerSchemeFeatures, CourierPartnerList, ShipmentsCourierPartnersServiceability, CPShipments, ShipmentsArticles, ArticleWeight, ArticleAttributes, ArticleDimension, ArticleSet, ArticleSizeDistribution, SetSize, ArticleDeliverySlots, ArticleReturnReason, CourierPartners, ShipmentCourierPartners, CourierPartnerConfig, BuyboxRuleConfig, PromiseConfig, StorePromiseAttributeConfig, DeliveryServiceAttributeConfig, BufferField, StorePrioritySchema, StoreRuleConditionSchema, CustomerRadiusSchema, CourierPartnerSchemeModel, PackageMaterialRule, PackageMaterialRuleQuantity, Channel, PackageRuleCategory, PackageRuleProduct, PackageRuleProductTag, PackageRuleDepartmentId, PackageRuleProductAttributes, PackageChannel, StoreFilter, PackageRuleSchema, Quantity, PackagePageInfo, OptimalLocationAssignedStoresResult, OptimalLocationArticlesResult, ArticleAssignment, LocationDetailsServiceability, ServiceabilityLocation, OptimalLocationsArticles, GetCountriesItems, HierarchyItems, CurrencyObject, Localities, PincodeLatLongData, LocalityParent, CountryMetaFields, ApplicationFields, GetCountryFieldsAddress, FieldValidation, FieldValidationRegex, LengthValidation, GetCountryFieldsAddressValues, GetOneOrAll, GetOneOrAllParams, GetOneOrAllPath, GetOneOrAllQuery, GetCountryFieldsAddressTemplateApplication, CountryHierarchy, GetCountryFields, GetCountryFieldsAddressTemplate, LocalityParents, ZoneConfig, PromiseType, InstallCourierPartnerItemsSchema, HistoryObject };
|
|
2488
2491
|
}
|
|
2489
2492
|
/** @returns {PlatformShipmentsRequestSchema} */
|
|
2490
2493
|
declare function PlatformShipmentsRequestSchema(): PlatformShipmentsRequestSchema;
|
|
@@ -2570,6 +2573,10 @@ type FulfillmentOption = {
|
|
|
2570
2573
|
* - Status of the fulfillment option.
|
|
2571
2574
|
*/
|
|
2572
2575
|
status?: string;
|
|
2576
|
+
/**
|
|
2577
|
+
* - Name of the ordering-channel or
|
|
2578
|
+
* business, e.g. storefront, storeos.
|
|
2579
|
+
*/
|
|
2573
2580
|
business_unit?: BusinessUnit[];
|
|
2574
2581
|
fulfillment_stores?: FulfillmentStores;
|
|
2575
2582
|
products?: FulfillmentProducts;
|
|
@@ -3142,7 +3149,10 @@ type PincodeMopBulkError = {
|
|
|
3142
3149
|
* - Status code for the error.
|
|
3143
3150
|
*/
|
|
3144
3151
|
status_code?: number;
|
|
3145
|
-
|
|
3152
|
+
/**
|
|
3153
|
+
* - An array containing error details.
|
|
3154
|
+
*/
|
|
3155
|
+
error?: Error[];
|
|
3146
3156
|
/**
|
|
3147
3157
|
* - Whether operation was successful.
|
|
3148
3158
|
*/
|
|
@@ -3155,7 +3165,10 @@ type CommonError = {
|
|
|
3155
3165
|
* - Status code for the error.
|
|
3156
3166
|
*/
|
|
3157
3167
|
status_code?: number;
|
|
3158
|
-
|
|
3168
|
+
/**
|
|
3169
|
+
* - An array containing error details.
|
|
3170
|
+
*/
|
|
3171
|
+
error?: Error[];
|
|
3159
3172
|
/**
|
|
3160
3173
|
* - Whether operation was successful.
|
|
3161
3174
|
*/
|
|
@@ -3729,10 +3742,10 @@ type CourierPartnerRule = {
|
|
|
3729
3742
|
*/
|
|
3730
3743
|
manual_priority: string[];
|
|
3731
3744
|
/**
|
|
3732
|
-
* - Denotes weather specific filters are applied
|
|
3733
|
-
* courier partner accounts or all accounts are considered.
|
|
3745
|
+
* - Denotes weather specific filters are applied
|
|
3746
|
+
* to courier partner accounts or all accounts are considered.
|
|
3734
3747
|
*/
|
|
3735
|
-
filters
|
|
3748
|
+
filters?: string;
|
|
3736
3749
|
conditions: CourierPartnerRuleConditions;
|
|
3737
3750
|
/**
|
|
3738
3751
|
* - Sort Strategy for the courier partners.
|
|
@@ -5428,7 +5441,7 @@ type PlatformLocationArticles = {
|
|
|
5428
5441
|
* - Unique identifier for the
|
|
5429
5442
|
* fulfillment location.
|
|
5430
5443
|
*/
|
|
5431
|
-
fulfillment_location_id
|
|
5444
|
+
fulfillment_location_id: number;
|
|
5432
5445
|
/**
|
|
5433
5446
|
* - Tags associated with the
|
|
5434
5447
|
* fulfillment location.
|
|
@@ -5569,6 +5582,15 @@ type PlatformShipmentsSchema = {
|
|
|
5569
5582
|
* partners handling the shipment.
|
|
5570
5583
|
*/
|
|
5571
5584
|
courier_partners?: ShipmentsCourierPartner[];
|
|
5585
|
+
/**
|
|
5586
|
+
* - The number of items in the shipment.
|
|
5587
|
+
*/
|
|
5588
|
+
count?: number;
|
|
5589
|
+
/**
|
|
5590
|
+
* - Flag indicating whether Cash on
|
|
5591
|
+
* Delivery (COD) is available for the shipment.
|
|
5592
|
+
*/
|
|
5593
|
+
is_cod_available?: boolean;
|
|
5572
5594
|
};
|
|
5573
5595
|
/** @returns {Packaging} */
|
|
5574
5596
|
declare function Packaging(): Packaging;
|
|
@@ -6341,7 +6363,7 @@ type Page = {
|
|
|
6341
6363
|
*/
|
|
6342
6364
|
current?: number;
|
|
6343
6365
|
/**
|
|
6344
|
-
* - The type of the page,
|
|
6366
|
+
* - The type of the page, can be 'cursor' or 'number'.
|
|
6345
6367
|
*/
|
|
6346
6368
|
type: string;
|
|
6347
6369
|
/**
|
|
@@ -6507,8 +6529,8 @@ type ListViewItems = {
|
|
|
6507
6529
|
* - The unique identifier of the application.
|
|
6508
6530
|
*/
|
|
6509
6531
|
application_id: string;
|
|
6510
|
-
created_by
|
|
6511
|
-
modified_by
|
|
6532
|
+
created_by?: CreatedBy;
|
|
6533
|
+
modified_by?: ModifiedBy;
|
|
6512
6534
|
/**
|
|
6513
6535
|
* - The timestamp when the record was created.
|
|
6514
6536
|
*/
|
|
@@ -6913,7 +6935,7 @@ type CourierPartnerRuleConditions = {
|
|
|
6913
6935
|
zone_ids?: StringComparisonOperations;
|
|
6914
6936
|
department_ids?: IntComparisonOperations;
|
|
6915
6937
|
brand_ids?: IntComparisonOperations;
|
|
6916
|
-
order_place_date?:
|
|
6938
|
+
order_place_date?: DateOperations;
|
|
6917
6939
|
store_ids?: IntComparisonOperations;
|
|
6918
6940
|
store_type?: StringComparisonOperations;
|
|
6919
6941
|
store_tags?: StringComparisonOperations;
|
|
@@ -6988,6 +7010,18 @@ type IntComparisonOperations = {
|
|
|
6988
7010
|
*/
|
|
6989
7011
|
includes?: number[];
|
|
6990
7012
|
};
|
|
7013
|
+
/** @returns {DateOperations} */
|
|
7014
|
+
declare function DateOperations(): DateOperations;
|
|
7015
|
+
type DateOperations = {
|
|
7016
|
+
/**
|
|
7017
|
+
* - Less than or equal to condition for date.
|
|
7018
|
+
*/
|
|
7019
|
+
lte: string;
|
|
7020
|
+
/**
|
|
7021
|
+
* - Greater than or equal to condition for date.
|
|
7022
|
+
*/
|
|
7023
|
+
gte: string;
|
|
7024
|
+
};
|
|
6991
7025
|
/** @returns {ArithmeticOperations} */
|
|
6992
7026
|
declare function ArithmeticOperations(): ArithmeticOperations;
|
|
6993
7027
|
type ArithmeticOperations = {
|
|
@@ -7633,26 +7667,6 @@ type CustomerRadiusSchema = {
|
|
|
7633
7667
|
*/
|
|
7634
7668
|
gte?: number;
|
|
7635
7669
|
};
|
|
7636
|
-
/** @returns {DateOperations} */
|
|
7637
|
-
declare function DateOperations(): DateOperations;
|
|
7638
|
-
type DateOperations = {
|
|
7639
|
-
/**
|
|
7640
|
-
* - Less than condition for date.
|
|
7641
|
-
*/
|
|
7642
|
-
lt?: string;
|
|
7643
|
-
/**
|
|
7644
|
-
* - Greater than condition for date.
|
|
7645
|
-
*/
|
|
7646
|
-
gt?: string;
|
|
7647
|
-
/**
|
|
7648
|
-
* - Less than or equal to condition for date.
|
|
7649
|
-
*/
|
|
7650
|
-
lte?: string;
|
|
7651
|
-
/**
|
|
7652
|
-
* - Greater than or equal to condition for date.
|
|
7653
|
-
*/
|
|
7654
|
-
gte?: string;
|
|
7655
|
-
};
|
|
7656
7670
|
/** @returns {CourierPartnerSchemeModel} */
|
|
7657
7671
|
declare function CourierPartnerSchemeModel(): CourierPartnerSchemeModel;
|
|
7658
7672
|
type CourierPartnerSchemeModel = {
|
|
@@ -8286,6 +8300,10 @@ type CountryMetaFields = {
|
|
|
8286
8300
|
/** @returns {ApplicationFields} */
|
|
8287
8301
|
declare function ApplicationFields(): ApplicationFields;
|
|
8288
8302
|
type ApplicationFields = {
|
|
8303
|
+
/**
|
|
8304
|
+
* - List of address-related
|
|
8305
|
+
* fields for the application.
|
|
8306
|
+
*/
|
|
8289
8307
|
address?: GetCountryFieldsAddress[];
|
|
8290
8308
|
/**
|
|
8291
8309
|
* - An array of strings
|