@gofynd/fdk-client-javascript 1.4.15 → 1.4.16-beta.1
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/Cart/CartApplicationClient.d.ts +11 -11
- package/sdk/application/Cart/CartApplicationClient.js +343 -48
- package/sdk/application/Catalog/CatalogApplicationClient.js +408 -0
- package/sdk/application/Common/CommonApplicationClient.js +21 -0
- package/sdk/application/Communication/CommunicationApplicationClient.js +29 -0
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +147 -0
- package/sdk/application/Content/ContentApplicationClient.d.ts +20 -0
- package/sdk/application/Content/ContentApplicationClient.js +327 -0
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +43 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +21 -0
- package/sdk/application/Lead/LeadApplicationClient.js +73 -0
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.js +182 -2
- package/sdk/application/Order/OrderApplicationClient.js +202 -0
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +0 -10
- package/sdk/application/Payment/PaymentApplicationClient.js +445 -38
- package/sdk/application/Rewards/RewardsApplicationClient.js +68 -0
- package/sdk/application/Share/ShareApplicationClient.js +96 -0
- package/sdk/application/Theme/ThemeApplicationClient.js +64 -0
- package/sdk/application/User/UserApplicationClient.js +412 -0
- package/sdk/application/Webhook/WebhookApplicationClient.js +13 -0
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +12 -33
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +38 -209
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +19 -399
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +11 -212
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +1 -3
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +7 -22
- package/sdk/partner/OAuthClient.js +1 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +3 -40
- package/sdk/partner/Theme/ThemePartnerModel.js +2 -24
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +12 -3
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +11 -1
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +4 -1
- package/sdk/platform/Cart/CartPlatformModel.d.ts +14 -28
- package/sdk/platform/Cart/CartPlatformModel.js +7 -13
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +0 -24
- package/sdk/platform/Catalog/CatalogPlatformClient.js +0 -176
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +29 -80
- package/sdk/platform/Catalog/CatalogPlatformModel.js +32 -72
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1 -45
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +0 -35
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +7 -0
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +3 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +52 -0
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +411 -0
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +85 -1
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +73 -0
- package/sdk/platform/Content/ContentPlatformModel.d.ts +90 -1
- package/sdk/platform/Content/ContentPlatformModel.js +104 -0
- package/sdk/platform/Order/OrderPlatformClient.d.ts +2 -2
- package/sdk/platform/Order/OrderPlatformClient.js +0 -8
- package/sdk/platform/Order/OrderPlatformModel.d.ts +3 -75
- package/sdk/platform/Order/OrderPlatformModel.js +2 -43
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +0 -22
- package/sdk/platform/Order/OrderPlatformValidator.js +0 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +10 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +118 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +53 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +29 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +0 -104
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +74 -816
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +23 -598
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +20 -382
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +1 -191
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +0 -138
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +3 -40
- package/sdk/platform/Theme/ThemePlatformModel.js +2 -24
- package/sdk/public/Configuration/ConfigurationPublicClient.js +16 -0
- package/sdk/public/Content/ContentPublicClient.js +116 -0
- package/sdk/public/Partner/PartnerPublicClient.js +15 -0
- package/sdk/public/Webhook/WebhookPublicClient.js +40 -0
|
@@ -1648,28 +1648,6 @@ const Joi = require("joi");
|
|
|
1648
1648
|
* @property {VerifyOtpResponseData} [data]
|
|
1649
1649
|
*/
|
|
1650
1650
|
|
|
1651
|
-
/**
|
|
1652
|
-
* @typedef BulkReportsFiltersSchema
|
|
1653
|
-
* @property {string} [bag_status] - Comma separated values of bag statuses(to
|
|
1654
|
-
* be deprecated).
|
|
1655
|
-
* @property {string} [operational_status] - Comma separated values of
|
|
1656
|
-
* shipment's operational statuses.
|
|
1657
|
-
* @property {string} [stores] - Comma separated values of store ids.
|
|
1658
|
-
* @property {string} [time_to_dispatch] - Specifies the type of shipments to
|
|
1659
|
-
* retrieve. Use "1" for non-breached shipments and "-1" for breached shipments.
|
|
1660
|
-
* @property {string} [payment_methods] - Filters shipments by payment method.
|
|
1661
|
-
* Use "PREPAID" for shipments paid in advance, and "COD" for cash-on-delivery
|
|
1662
|
-
* shipments.
|
|
1663
|
-
* @property {string} [dp_ids] - Comma separated values of delivery partners.
|
|
1664
|
-
* Either dp_id or slug(extension_id|scheme_id).
|
|
1665
|
-
* @property {string} [sales_channels] - Comma separated values of sales channels ids.
|
|
1666
|
-
* @property {string} [tags] - A comma-separated list of tags associated with
|
|
1667
|
-
* the entity. Each tag is a keyword or label that categorizes or describes the entity.
|
|
1668
|
-
* @property {string} [lock_status] - Indicates the lock status of the entity.
|
|
1669
|
-
* "true" means the shipment is in a complete or partial lock state, while
|
|
1670
|
-
* "false" means it is unlocked.
|
|
1671
|
-
*/
|
|
1672
|
-
|
|
1673
1651
|
/**
|
|
1674
1652
|
* @typedef BulkReportsDownloadRequestSchema
|
|
1675
1653
|
* @property {string[]} [store_ids] - A list of specific store IDs for which the
|
|
@@ -1691,7 +1669,6 @@ const Joi = require("joi");
|
|
|
1691
1669
|
* should include data from cross-company operations.
|
|
1692
1670
|
* @property {Object} [custom_filters_for_lane] - A flexible object that allows
|
|
1693
1671
|
* users to define custom filters specific to the lanes being reported on.
|
|
1694
|
-
* @property {BulkReportsFiltersSchema} [filters]
|
|
1695
1672
|
*/
|
|
1696
1673
|
|
|
1697
1674
|
/**
|
|
@@ -3321,7 +3298,7 @@ const Joi = require("joi");
|
|
|
3321
3298
|
|
|
3322
3299
|
/**
|
|
3323
3300
|
* @typedef Article
|
|
3324
|
-
* @property {Object
|
|
3301
|
+
* @property {Object} [child_details] - Contains a flexible set of key-value
|
|
3325
3302
|
* pairs representing detailed information about the article's child entities,
|
|
3326
3303
|
* including dimensions (width, height, length), weight, and unique
|
|
3327
3304
|
* identifiers (EAN, article code, seller identifier) for each child entity.
|
|
@@ -6835,21 +6812,6 @@ class OrderPlatformModel {
|
|
|
6835
6812
|
});
|
|
6836
6813
|
}
|
|
6837
6814
|
|
|
6838
|
-
/** @returns {BulkReportsFiltersSchema} */
|
|
6839
|
-
static BulkReportsFiltersSchema() {
|
|
6840
|
-
return Joi.object({
|
|
6841
|
-
bag_status: Joi.string().allow(""),
|
|
6842
|
-
operational_status: Joi.string().allow(""),
|
|
6843
|
-
stores: Joi.string().allow(""),
|
|
6844
|
-
time_to_dispatch: Joi.string().allow(""),
|
|
6845
|
-
payment_methods: Joi.string().allow(""),
|
|
6846
|
-
dp_ids: Joi.string().allow(""),
|
|
6847
|
-
sales_channels: Joi.string().allow(""),
|
|
6848
|
-
tags: Joi.string().allow(""),
|
|
6849
|
-
lock_status: Joi.string().allow(""),
|
|
6850
|
-
});
|
|
6851
|
-
}
|
|
6852
|
-
|
|
6853
6815
|
/** @returns {BulkReportsDownloadRequestSchema} */
|
|
6854
6816
|
static BulkReportsDownloadRequestSchema() {
|
|
6855
6817
|
return Joi.object({
|
|
@@ -6863,7 +6825,6 @@ class OrderPlatformModel {
|
|
|
6863
6825
|
filter_type: Joi.string().allow(""),
|
|
6864
6826
|
is_cross_company_enabled: Joi.boolean(),
|
|
6865
6827
|
custom_filters_for_lane: Joi.object().pattern(/\S/, Joi.any()),
|
|
6866
|
-
filters: OrderPlatformModel.BulkReportsFiltersSchema(),
|
|
6867
6828
|
});
|
|
6868
6829
|
}
|
|
6869
6830
|
|
|
@@ -8218,9 +8179,7 @@ class OrderPlatformModel {
|
|
|
8218
8179
|
/** @returns {Article} */
|
|
8219
8180
|
static Article() {
|
|
8220
8181
|
return Joi.object({
|
|
8221
|
-
child_details: Joi.
|
|
8222
|
-
.items(Joi.object().pattern(/\S/, Joi.any()))
|
|
8223
|
-
.allow(null, ""),
|
|
8182
|
+
child_details: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
|
|
8224
8183
|
seller_identifier: Joi.string().allow("").required(),
|
|
8225
8184
|
uid: Joi.string().allow("").required(),
|
|
8226
8185
|
set: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
|
|
@@ -258,10 +258,6 @@ export = OrderPlatformValidator;
|
|
|
258
258
|
* @property {boolean} [enforceDateFilter] - Applies a date filter for listing
|
|
259
259
|
* orders. This is useful when fetching data for a specific date range while
|
|
260
260
|
* performing searches.
|
|
261
|
-
* @property {string} [fulfillmentType] - Define the Fulfillment Type for
|
|
262
|
-
* Listing Orders, This is use when we want to get list of shipments or orders
|
|
263
|
-
* by cross store or cross company or fulfilling Store (by default), this is
|
|
264
|
-
* also depends on the login user accessType and store access
|
|
265
261
|
*/
|
|
266
262
|
/** @typedef GetRoleBasedActionsParam */
|
|
267
263
|
/**
|
|
@@ -349,10 +345,6 @@ export = OrderPlatformValidator;
|
|
|
349
345
|
* @property {boolean} [enforceDateFilter] - Applies a date filter for listing
|
|
350
346
|
* shipments. This is useful when fetching data for a specific date range
|
|
351
347
|
* while performing searches.
|
|
352
|
-
* @property {string} [fulfillmentType] - Define the Fulfillment Type for
|
|
353
|
-
* Listing Orders, This is use when we want to get list of shipments or orders
|
|
354
|
-
* by cross store or cross company or fulfilling Store (by default), this is
|
|
355
|
-
* also depends on the login user accessType and store access
|
|
356
348
|
*/
|
|
357
349
|
/**
|
|
358
350
|
* @typedef GetStateManagerConfigParam
|
|
@@ -1085,13 +1077,6 @@ type GetOrdersParam = {
|
|
|
1085
1077
|
* performing searches.
|
|
1086
1078
|
*/
|
|
1087
1079
|
enforceDateFilter?: boolean;
|
|
1088
|
-
/**
|
|
1089
|
-
* - Define the Fulfillment Type for
|
|
1090
|
-
* Listing Orders, This is use when we want to get list of shipments or orders
|
|
1091
|
-
* by cross store or cross company or fulfilling Store (by default), this is
|
|
1092
|
-
* also depends on the login user accessType and store access
|
|
1093
|
-
*/
|
|
1094
|
-
fulfillmentType?: string;
|
|
1095
1080
|
};
|
|
1096
1081
|
type GetShipmentByIdParam = {
|
|
1097
1082
|
/**
|
|
@@ -1300,13 +1285,6 @@ type GetShipmentsParam = {
|
|
|
1300
1285
|
* while performing searches.
|
|
1301
1286
|
*/
|
|
1302
1287
|
enforceDateFilter?: boolean;
|
|
1303
|
-
/**
|
|
1304
|
-
* - Define the Fulfillment Type for
|
|
1305
|
-
* Listing Orders, This is use when we want to get list of shipments or orders
|
|
1306
|
-
* by cross store or cross company or fulfilling Store (by default), this is
|
|
1307
|
-
* also depends on the login user accessType and store access
|
|
1308
|
-
*/
|
|
1309
|
-
fulfillmentType?: string;
|
|
1310
1288
|
};
|
|
1311
1289
|
type GetStateManagerConfigParam = {
|
|
1312
1290
|
/**
|
|
@@ -292,10 +292,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
292
292
|
* @property {boolean} [enforceDateFilter] - Applies a date filter for listing
|
|
293
293
|
* orders. This is useful when fetching data for a specific date range while
|
|
294
294
|
* performing searches.
|
|
295
|
-
* @property {string} [fulfillmentType] - Define the Fulfillment Type for
|
|
296
|
-
* Listing Orders, This is use when we want to get list of shipments or orders
|
|
297
|
-
* by cross store or cross company or fulfilling Store (by default), this is
|
|
298
|
-
* also depends on the login user accessType and store access
|
|
299
295
|
*/
|
|
300
296
|
|
|
301
297
|
/** @typedef GetRoleBasedActionsParam */
|
|
@@ -388,10 +384,6 @@ const OrderPlatformModel = require("./OrderPlatformModel");
|
|
|
388
384
|
* @property {boolean} [enforceDateFilter] - Applies a date filter for listing
|
|
389
385
|
* shipments. This is useful when fetching data for a specific date range
|
|
390
386
|
* while performing searches.
|
|
391
|
-
* @property {string} [fulfillmentType] - Define the Fulfillment Type for
|
|
392
|
-
* Listing Orders, This is use when we want to get list of shipments or orders
|
|
393
|
-
* by cross store or cross company or fulfilling Store (by default), this is
|
|
394
|
-
* also depends on the login user accessType and store access
|
|
395
387
|
*/
|
|
396
388
|
|
|
397
389
|
/**
|
|
@@ -815,7 +807,6 @@ class OrderPlatformValidator {
|
|
|
815
807
|
allowInactive: Joi.boolean(),
|
|
816
808
|
groupEntity: Joi.string().allow(""),
|
|
817
809
|
enforceDateFilter: Joi.boolean(),
|
|
818
|
-
fulfillmentType: Joi.string().allow(""),
|
|
819
810
|
}).required();
|
|
820
811
|
}
|
|
821
812
|
|
|
@@ -887,7 +878,6 @@ class OrderPlatformValidator {
|
|
|
887
878
|
orderType: Joi.string().allow(""),
|
|
888
879
|
groupEntity: Joi.string().allow(""),
|
|
889
880
|
enforceDateFilter: Joi.boolean(),
|
|
890
|
-
fulfillmentType: Joi.string().allow(""),
|
|
891
881
|
}).required();
|
|
892
882
|
}
|
|
893
883
|
|
|
@@ -138,6 +138,16 @@ declare class Serviceability {
|
|
|
138
138
|
* @description: Retrieves an existing order routing setup for a single application - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getStoreRules/).
|
|
139
139
|
*/
|
|
140
140
|
getStoreRules({ pageNo, pageSize, status, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetStoreRulesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetStoreRulesApiResult>;
|
|
141
|
+
/**
|
|
142
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetZonesParam} arg - Arg object
|
|
143
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
144
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
145
|
+
* @returns {Promise<ServiceabilityPlatformModel.ListViewResult>} - Success response
|
|
146
|
+
* @name getZones
|
|
147
|
+
* @summary: Get zones
|
|
148
|
+
* @description: Retrieves a list of delivery zones. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getZones/).
|
|
149
|
+
*/
|
|
150
|
+
getZones({ pageNo, pageSize, isActive, q, countryIsoCode, state, city, pincode, sector, requestHeaders, }?: ServiceabilityPlatformApplicationValidator.GetZonesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ListViewResult>;
|
|
141
151
|
/**
|
|
142
152
|
* @param {ServiceabilityPlatformApplicationValidator.InsertApplicationConfigParam} arg
|
|
143
153
|
* - Arg object
|
|
@@ -842,6 +842,124 @@ class Serviceability {
|
|
|
842
842
|
return response;
|
|
843
843
|
}
|
|
844
844
|
|
|
845
|
+
/**
|
|
846
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetZonesParam} arg - Arg object
|
|
847
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
848
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
849
|
+
* @returns {Promise<ServiceabilityPlatformModel.ListViewResult>} - Success response
|
|
850
|
+
* @name getZones
|
|
851
|
+
* @summary: Get zones
|
|
852
|
+
* @description: Retrieves a list of delivery zones. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getZones/).
|
|
853
|
+
*/
|
|
854
|
+
async getZones(
|
|
855
|
+
{
|
|
856
|
+
pageNo,
|
|
857
|
+
pageSize,
|
|
858
|
+
isActive,
|
|
859
|
+
q,
|
|
860
|
+
countryIsoCode,
|
|
861
|
+
state,
|
|
862
|
+
city,
|
|
863
|
+
pincode,
|
|
864
|
+
sector,
|
|
865
|
+
requestHeaders,
|
|
866
|
+
} = { requestHeaders: {} },
|
|
867
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
868
|
+
) {
|
|
869
|
+
const {
|
|
870
|
+
error,
|
|
871
|
+
} = ServiceabilityPlatformApplicationValidator.getZones().validate(
|
|
872
|
+
{
|
|
873
|
+
pageNo,
|
|
874
|
+
pageSize,
|
|
875
|
+
isActive,
|
|
876
|
+
|
|
877
|
+
q,
|
|
878
|
+
countryIsoCode,
|
|
879
|
+
state,
|
|
880
|
+
city,
|
|
881
|
+
pincode,
|
|
882
|
+
sector,
|
|
883
|
+
},
|
|
884
|
+
{ abortEarly: false, allowUnknown: true }
|
|
885
|
+
);
|
|
886
|
+
if (error) {
|
|
887
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
888
|
+
}
|
|
889
|
+
|
|
890
|
+
// Showing warrnings if extra unknown parameters are found
|
|
891
|
+
const {
|
|
892
|
+
error: warrning,
|
|
893
|
+
} = ServiceabilityPlatformApplicationValidator.getZones().validate(
|
|
894
|
+
{
|
|
895
|
+
pageNo,
|
|
896
|
+
pageSize,
|
|
897
|
+
isActive,
|
|
898
|
+
|
|
899
|
+
q,
|
|
900
|
+
countryIsoCode,
|
|
901
|
+
state,
|
|
902
|
+
city,
|
|
903
|
+
pincode,
|
|
904
|
+
sector,
|
|
905
|
+
},
|
|
906
|
+
{ abortEarly: false, allowUnknown: false }
|
|
907
|
+
);
|
|
908
|
+
if (warrning) {
|
|
909
|
+
Logger({
|
|
910
|
+
level: "WARN",
|
|
911
|
+
message: `Parameter Validation warrnings for platform > Serviceability > getZones \n ${warrning}`,
|
|
912
|
+
});
|
|
913
|
+
}
|
|
914
|
+
|
|
915
|
+
const query_params = {};
|
|
916
|
+
query_params["page_no"] = pageNo;
|
|
917
|
+
query_params["page_size"] = pageSize;
|
|
918
|
+
query_params["is_active"] = isActive;
|
|
919
|
+
query_params["application_id"] = applicationId;
|
|
920
|
+
query_params["q"] = q;
|
|
921
|
+
query_params["country_iso_code"] = countryIsoCode;
|
|
922
|
+
query_params["state"] = state;
|
|
923
|
+
query_params["city"] = city;
|
|
924
|
+
query_params["pincode"] = pincode;
|
|
925
|
+
query_params["sector"] = sector;
|
|
926
|
+
|
|
927
|
+
const response = await PlatformAPIClient.execute(
|
|
928
|
+
this.config,
|
|
929
|
+
"get",
|
|
930
|
+
`/service/platform/logistics/v2.0/company/${this.config.companyId}/zones`,
|
|
931
|
+
query_params,
|
|
932
|
+
undefined,
|
|
933
|
+
requestHeaders,
|
|
934
|
+
{ responseHeaders }
|
|
935
|
+
);
|
|
936
|
+
|
|
937
|
+
let responseData = response;
|
|
938
|
+
if (responseHeaders) {
|
|
939
|
+
responseData = response[0];
|
|
940
|
+
}
|
|
941
|
+
|
|
942
|
+
const {
|
|
943
|
+
error: res_error,
|
|
944
|
+
} = ServiceabilityPlatformModel.ListViewResult().validate(responseData, {
|
|
945
|
+
abortEarly: false,
|
|
946
|
+
allowUnknown: true,
|
|
947
|
+
});
|
|
948
|
+
|
|
949
|
+
if (res_error) {
|
|
950
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
951
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
952
|
+
} else {
|
|
953
|
+
Logger({
|
|
954
|
+
level: "WARN",
|
|
955
|
+
message: `Response Validation Warnings for platform > Serviceability > getZones \n ${res_error}`,
|
|
956
|
+
});
|
|
957
|
+
}
|
|
958
|
+
}
|
|
959
|
+
|
|
960
|
+
return response;
|
|
961
|
+
}
|
|
962
|
+
|
|
845
963
|
/**
|
|
846
964
|
* @param {ServiceabilityPlatformApplicationValidator.InsertApplicationConfigParam} arg
|
|
847
965
|
* - Arg object
|
|
@@ -35,6 +35,18 @@ export = ServiceabilityPlatformApplicationValidator;
|
|
|
35
35
|
* @property {number} [pageSize]
|
|
36
36
|
* @property {string} [status]
|
|
37
37
|
*/
|
|
38
|
+
/**
|
|
39
|
+
* @typedef GetZonesParam
|
|
40
|
+
* @property {number} [pageNo] - Index of the item to start returning with
|
|
41
|
+
* @property {number} [pageSize] - Determines the items to be displayed in a page
|
|
42
|
+
* @property {boolean} [isActive] - Status of Zone (either active or inactive)
|
|
43
|
+
* @property {string} [q] - Search with name as a free text
|
|
44
|
+
* @property {string} [countryIsoCode] - ISO2 code of the country
|
|
45
|
+
* @property {string} [state] - State name
|
|
46
|
+
* @property {string} [city] - City name
|
|
47
|
+
* @property {string} [pincode] - Pincode value to search zones
|
|
48
|
+
* @property {string} [sector] - Sector value to search zones
|
|
49
|
+
*/
|
|
38
50
|
/**
|
|
39
51
|
* @typedef InsertApplicationConfigParam
|
|
40
52
|
* @property {ServiceabilityPlatformModel.StoreRuleConfigData} body
|
|
@@ -107,6 +119,8 @@ declare class ServiceabilityPlatformApplicationValidator {
|
|
|
107
119
|
static getStoreRule(): GetStoreRuleParam;
|
|
108
120
|
/** @returns {GetStoreRulesParam} */
|
|
109
121
|
static getStoreRules(): GetStoreRulesParam;
|
|
122
|
+
/** @returns {GetZonesParam} */
|
|
123
|
+
static getZones(): GetZonesParam;
|
|
110
124
|
/** @returns {InsertApplicationConfigParam} */
|
|
111
125
|
static insertApplicationConfig(): InsertApplicationConfigParam;
|
|
112
126
|
/** @returns {PatchApplicationServiceabilitySelfShipmentParam} */
|
|
@@ -131,7 +145,7 @@ declare class ServiceabilityPlatformApplicationValidator {
|
|
|
131
145
|
static updateStoreRulesConfig(): UpdateStoreRulesConfigParam;
|
|
132
146
|
}
|
|
133
147
|
declare namespace ServiceabilityPlatformApplicationValidator {
|
|
134
|
-
export { CreateCourierPartnerRuleParam, CreateStoreRulesParam, GetApplicationConfigParam, GetApplicationConfigurationParam, GetApplicationServiceabilitySelfShipmentParam, GetCourierPartnerRuleParam, GetCourierPartnerRulesParam, GetCourierPartnersParam, GetStoreRuleParam, GetStoreRulesParam, InsertApplicationConfigParam, PatchApplicationServiceabilitySelfShipmentParam, UpdateApplicationConfigurationParam, UpdateCourierPartnerRulePriorityParam, UpdateCourierRuleParam, UpdatePincodeAuditHistoryParam, UpdatePincodeBulkViewParam, UpdatePincodeCoDListingParam, UpdatePincodeMopViewParam, UpdateStoreRulesParam, UpdateStoreRulesConfigParam };
|
|
148
|
+
export { CreateCourierPartnerRuleParam, CreateStoreRulesParam, GetApplicationConfigParam, GetApplicationConfigurationParam, GetApplicationServiceabilitySelfShipmentParam, GetCourierPartnerRuleParam, GetCourierPartnerRulesParam, GetCourierPartnersParam, GetStoreRuleParam, GetStoreRulesParam, GetZonesParam, InsertApplicationConfigParam, PatchApplicationServiceabilitySelfShipmentParam, UpdateApplicationConfigurationParam, UpdateCourierPartnerRulePriorityParam, UpdateCourierRuleParam, UpdatePincodeAuditHistoryParam, UpdatePincodeBulkViewParam, UpdatePincodeCoDListingParam, UpdatePincodeMopViewParam, UpdateStoreRulesParam, UpdateStoreRulesConfigParam };
|
|
135
149
|
}
|
|
136
150
|
type CreateCourierPartnerRuleParam = {
|
|
137
151
|
body: ServiceabilityPlatformModel.CourierPartnerRule;
|
|
@@ -174,6 +188,44 @@ type GetStoreRulesParam = {
|
|
|
174
188
|
pageSize?: number;
|
|
175
189
|
status?: string;
|
|
176
190
|
};
|
|
191
|
+
type GetZonesParam = {
|
|
192
|
+
/**
|
|
193
|
+
* - Index of the item to start returning with
|
|
194
|
+
*/
|
|
195
|
+
pageNo?: number;
|
|
196
|
+
/**
|
|
197
|
+
* - Determines the items to be displayed in a page
|
|
198
|
+
*/
|
|
199
|
+
pageSize?: number;
|
|
200
|
+
/**
|
|
201
|
+
* - Status of Zone (either active or inactive)
|
|
202
|
+
*/
|
|
203
|
+
isActive?: boolean;
|
|
204
|
+
/**
|
|
205
|
+
* - Search with name as a free text
|
|
206
|
+
*/
|
|
207
|
+
q?: string;
|
|
208
|
+
/**
|
|
209
|
+
* - ISO2 code of the country
|
|
210
|
+
*/
|
|
211
|
+
countryIsoCode?: string;
|
|
212
|
+
/**
|
|
213
|
+
* - State name
|
|
214
|
+
*/
|
|
215
|
+
state?: string;
|
|
216
|
+
/**
|
|
217
|
+
* - City name
|
|
218
|
+
*/
|
|
219
|
+
city?: string;
|
|
220
|
+
/**
|
|
221
|
+
* - Pincode value to search zones
|
|
222
|
+
*/
|
|
223
|
+
pincode?: string;
|
|
224
|
+
/**
|
|
225
|
+
* - Sector value to search zones
|
|
226
|
+
*/
|
|
227
|
+
sector?: string;
|
|
228
|
+
};
|
|
177
229
|
type InsertApplicationConfigParam = {
|
|
178
230
|
body: ServiceabilityPlatformModel.StoreRuleConfigData;
|
|
179
231
|
};
|
|
@@ -48,6 +48,19 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
48
48
|
* @property {string} [status]
|
|
49
49
|
*/
|
|
50
50
|
|
|
51
|
+
/**
|
|
52
|
+
* @typedef GetZonesParam
|
|
53
|
+
* @property {number} [pageNo] - Index of the item to start returning with
|
|
54
|
+
* @property {number} [pageSize] - Determines the items to be displayed in a page
|
|
55
|
+
* @property {boolean} [isActive] - Status of Zone (either active or inactive)
|
|
56
|
+
* @property {string} [q] - Search with name as a free text
|
|
57
|
+
* @property {string} [countryIsoCode] - ISO2 code of the country
|
|
58
|
+
* @property {string} [state] - State name
|
|
59
|
+
* @property {string} [city] - City name
|
|
60
|
+
* @property {string} [pincode] - Pincode value to search zones
|
|
61
|
+
* @property {string} [sector] - Sector value to search zones
|
|
62
|
+
*/
|
|
63
|
+
|
|
51
64
|
/**
|
|
52
65
|
* @typedef InsertApplicationConfigParam
|
|
53
66
|
* @property {ServiceabilityPlatformModel.StoreRuleConfigData} body
|
|
@@ -179,6 +192,22 @@ class ServiceabilityPlatformApplicationValidator {
|
|
|
179
192
|
}).required();
|
|
180
193
|
}
|
|
181
194
|
|
|
195
|
+
/** @returns {GetZonesParam} */
|
|
196
|
+
static getZones() {
|
|
197
|
+
return Joi.object({
|
|
198
|
+
pageNo: Joi.number(),
|
|
199
|
+
pageSize: Joi.number(),
|
|
200
|
+
isActive: Joi.boolean(),
|
|
201
|
+
|
|
202
|
+
q: Joi.string().allow(""),
|
|
203
|
+
countryIsoCode: Joi.string().allow(""),
|
|
204
|
+
state: Joi.string().allow(""),
|
|
205
|
+
city: Joi.string().allow(""),
|
|
206
|
+
pincode: Joi.string().allow(""),
|
|
207
|
+
sector: Joi.string().allow(""),
|
|
208
|
+
}).required();
|
|
209
|
+
}
|
|
210
|
+
|
|
182
211
|
/** @returns {InsertApplicationConfigParam} */
|
|
183
212
|
static insertApplicationConfig() {
|
|
184
213
|
return Joi.object({
|
|
@@ -39,20 +39,6 @@ declare class Serviceability {
|
|
|
39
39
|
* @description: Creates a courier partner account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createCourierPartnerAccount/).
|
|
40
40
|
*/
|
|
41
41
|
createCourierPartnerAccount({ body, requestHeaders }?: ServiceabilityPlatformValidator.CreateCourierPartnerAccountParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierAccount>;
|
|
42
|
-
/**
|
|
43
|
-
* @param {ServiceabilityPlatformValidator.CreateCourierPartnerSchemeParam} arg
|
|
44
|
-
* - Arg object
|
|
45
|
-
*
|
|
46
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
47
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
48
|
-
* @returns {Promise<ServiceabilityPlatformModel.CourierPartnerV2SchemeModel>}
|
|
49
|
-
* - Success response
|
|
50
|
-
*
|
|
51
|
-
* @name createCourierPartnerScheme
|
|
52
|
-
* @summary: Create Scheme for courier partner extension
|
|
53
|
-
* @description: Create Scheme for courier partner extension - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/createCourierPartnerScheme/).
|
|
54
|
-
*/
|
|
55
|
-
createCourierPartnerScheme({ body, requestHeaders }?: ServiceabilityPlatformValidator.CreateCourierPartnerSchemeParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerV2SchemeModel>;
|
|
56
42
|
/**
|
|
57
43
|
* @param {ServiceabilityPlatformValidator.CreatePackageMaterialParam} arg
|
|
58
44
|
* - Arg object
|
|
@@ -134,16 +120,6 @@ declare class Serviceability {
|
|
|
134
120
|
* @description: Retrieves information about the delivery setup for a company - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCompanyConfiguration/).
|
|
135
121
|
*/
|
|
136
122
|
getCompanyConfiguration({ requestHeaders }?: any, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CompanyConfig>;
|
|
137
|
-
/**
|
|
138
|
-
* @param {ServiceabilityPlatformValidator.GetCountriesParam} arg - Arg object
|
|
139
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
140
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
141
|
-
* @returns {Promise<ServiceabilityPlatformModel.GetCountries>} - Success response
|
|
142
|
-
* @name getCountries
|
|
143
|
-
* @summary: Get countries
|
|
144
|
-
* @description: Retrieve a list of countries for logistical purposes. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCountries/).
|
|
145
|
-
*/
|
|
146
|
-
getCountries({ onboarding, pageNo, pageSize, q, hierarchy, requestHeaders }?: ServiceabilityPlatformValidator.GetCountriesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetCountries>;
|
|
147
123
|
/**
|
|
148
124
|
* @param {ServiceabilityPlatformValidator.GetCourierPartnerAccountParam} arg
|
|
149
125
|
* - Arg object
|
|
@@ -171,34 +147,6 @@ declare class Serviceability {
|
|
|
171
147
|
* @description: Retrieves a list of courier partner accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCourierPartnerAccounts/).
|
|
172
148
|
*/
|
|
173
149
|
getCourierPartnerAccounts({ pageNo, pageSize, stage, paymentMode, transportType, requestHeaders }?: ServiceabilityPlatformValidator.GetCourierPartnerAccountsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CompanyCourierPartnerAccountListResult>;
|
|
174
|
-
/**
|
|
175
|
-
* @param {ServiceabilityPlatformValidator.GetCourierPartnerSchemeParam} arg
|
|
176
|
-
* - Arg object
|
|
177
|
-
*
|
|
178
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
179
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
180
|
-
* @returns {Promise<ServiceabilityPlatformModel.CourierPartnerV2SchemeModel>}
|
|
181
|
-
* - Success response
|
|
182
|
-
*
|
|
183
|
-
* @name getCourierPartnerScheme
|
|
184
|
-
* @summary: Get Scheme for courier partner extension by Id
|
|
185
|
-
* @description: Update Scheme for courier partner extension by Id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCourierPartnerScheme/).
|
|
186
|
-
*/
|
|
187
|
-
getCourierPartnerScheme({ schemeId, requestHeaders }?: ServiceabilityPlatformValidator.GetCourierPartnerSchemeParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerV2SchemeModel>;
|
|
188
|
-
/**
|
|
189
|
-
* @param {ServiceabilityPlatformValidator.GetCourierPartnerSchemesParam} arg
|
|
190
|
-
* - Arg object
|
|
191
|
-
*
|
|
192
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
193
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
194
|
-
* @returns {Promise<ServiceabilityPlatformModel.courierPartnerSchemeV2List>}
|
|
195
|
-
* - Success response
|
|
196
|
-
*
|
|
197
|
-
* @name getCourierPartnerSchemes
|
|
198
|
-
* @summary: Get created Schemes for courier partner
|
|
199
|
-
* @description: Get created Schemes for courier partner - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getCourierPartnerSchemes/).
|
|
200
|
-
*/
|
|
201
|
-
getCourierPartnerSchemes({ schemeType, paymentMode, capabilities, schemeIds, requestHeaders }?: ServiceabilityPlatformValidator.GetCourierPartnerSchemesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.courierPartnerSchemeV2List>;
|
|
202
150
|
/**
|
|
203
151
|
* @param {ServiceabilityPlatformValidator.GetOptimalLocationsParam} arg - Arg object
|
|
204
152
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -261,20 +209,6 @@ declare class Serviceability {
|
|
|
261
209
|
* @description: Retrieve a single packaging material - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getPackageMaterials/).
|
|
262
210
|
*/
|
|
263
211
|
getPackageMaterials({ packageMaterialId, requestHeaders }?: ServiceabilityPlatformValidator.GetPackageMaterialsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.PackageMaterialResult>;
|
|
264
|
-
/**
|
|
265
|
-
* @param {ServiceabilityPlatformValidator.GetSampleFileServiceabilityStatusParam} arg
|
|
266
|
-
* - Arg object
|
|
267
|
-
*
|
|
268
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
269
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
270
|
-
* @returns {Promise<ServiceabilityPlatformModel.BulkRegionServiceabilityTatResult>}
|
|
271
|
-
* - Success response
|
|
272
|
-
*
|
|
273
|
-
* @name getSampleFileServiceabilityStatus
|
|
274
|
-
* @summary: Get Serviceability TAT sample files generator status
|
|
275
|
-
* @description: Get Serviceability TAT sample file generator status - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getSampleFileServiceabilityStatus/).
|
|
276
|
-
*/
|
|
277
|
-
getSampleFileServiceabilityStatus({ pageNo, pageSize, batchId, requestHeaders }?: ServiceabilityPlatformValidator.GetSampleFileServiceabilityStatusParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkRegionServiceabilityTatResult>;
|
|
278
212
|
/**
|
|
279
213
|
* @param {ServiceabilityPlatformValidator.GetServiceabilityParam} arg - Arg object
|
|
280
214
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -297,30 +231,6 @@ declare class Serviceability {
|
|
|
297
231
|
* @description: Retrieves a single delivery zone. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getZoneById/).
|
|
298
232
|
*/
|
|
299
233
|
getZoneById({ zoneId, requestHeaders }?: ServiceabilityPlatformValidator.GetZoneByIdParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetZoneByIdSchema>;
|
|
300
|
-
/**
|
|
301
|
-
* @param {ServiceabilityPlatformValidator.GetZonesParam} arg - Arg object
|
|
302
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
303
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
304
|
-
* @returns {Promise<ServiceabilityPlatformModel.ListViewResult>} - Success response
|
|
305
|
-
* @name getZones
|
|
306
|
-
* @summary: Get zones
|
|
307
|
-
* @description: Retrieves a list of delivery zones. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/getZones/).
|
|
308
|
-
*/
|
|
309
|
-
getZones({ pageNo, pageSize, isActive, channelId, q, countryIsoCode, state, city, pincode, sector, requestHeaders, }?: ServiceabilityPlatformValidator.GetZonesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ListViewResult>;
|
|
310
|
-
/**
|
|
311
|
-
* @param {ServiceabilityPlatformValidator.SampleFileServiceabilityParam} arg
|
|
312
|
-
* - Arg object
|
|
313
|
-
*
|
|
314
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
315
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
316
|
-
* @returns {Promise<ServiceabilityPlatformModel.BulkRegionServiceabilityTatResultItemData>}
|
|
317
|
-
* - Success response
|
|
318
|
-
*
|
|
319
|
-
* @name sampleFileServiceability
|
|
320
|
-
* @summary: Sample File Download
|
|
321
|
-
* @description: Sample File Download - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/sampleFileServiceability/).
|
|
322
|
-
*/
|
|
323
|
-
sampleFileServiceability({ body, requestHeaders }?: ServiceabilityPlatformValidator.SampleFileServiceabilityParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.BulkRegionServiceabilityTatResultItemData>;
|
|
324
234
|
/**
|
|
325
235
|
* @param {ServiceabilityPlatformValidator.UpdateCompanyConfigurationParam} arg
|
|
326
236
|
* - Arg object
|
|
@@ -346,20 +256,6 @@ declare class Serviceability {
|
|
|
346
256
|
* @description: Updates an existing courier partner account. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateCourierPartnerAccount/).
|
|
347
257
|
*/
|
|
348
258
|
updateCourierPartnerAccount({ accountId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdateCourierPartnerAccountParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierAccountResult>;
|
|
349
|
-
/**
|
|
350
|
-
* @param {ServiceabilityPlatformValidator.UpdateCourierPartnerSchemeParam} arg
|
|
351
|
-
* - Arg object
|
|
352
|
-
*
|
|
353
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
354
|
-
* @param {import("../PlatformAPIClient").Options} - Options
|
|
355
|
-
* @returns {Promise<ServiceabilityPlatformModel.CourierPartnerV2SchemeModel>}
|
|
356
|
-
* - Success response
|
|
357
|
-
*
|
|
358
|
-
* @name updateCourierPartnerScheme
|
|
359
|
-
* @summary: Update Scheme for courier partner extension
|
|
360
|
-
* @description: Update Scheme for courier partner extension - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/serviceability/updateCourierPartnerScheme/).
|
|
361
|
-
*/
|
|
362
|
-
updateCourierPartnerScheme({ schemeId, body, requestHeaders }?: ServiceabilityPlatformValidator.UpdateCourierPartnerSchemeParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerV2SchemeModel>;
|
|
363
259
|
/**
|
|
364
260
|
* @param {ServiceabilityPlatformValidator.UpdatePackageMaterialRuleParam} arg
|
|
365
261
|
* - Arg object
|