@gofynd/fdk-client-javascript 1.4.2-beta.3 → 1.4.2-beta.4
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/OrderApplicationModel.d.ts +6 -0
- package/sdk/application/Order/OrderApplicationModel.js +6 -0
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +27 -1
- package/sdk/application/Payment/PaymentApplicationModel.js +19 -0
- package/sdk/application/User/UserApplicationClient.d.ts +2 -2
- package/sdk/application/User/UserApplicationClient.js +4 -7
- package/sdk/application/User/UserApplicationModel.d.ts +32 -27
- package/sdk/application/User/UserApplicationModel.js +22 -32
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +26 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +182 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +70 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +44 -0
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +34 -1
- package/sdk/platform/Catalog/CatalogPlatformModel.js +44 -0
- package/sdk/platform/Content/ContentPlatformModel.d.ts +18 -1
- package/sdk/platform/Content/ContentPlatformModel.js +20 -0
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +2 -0
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +2 -0
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +7 -4
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +14 -1
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +16 -0
- package/sdk/platform/Order/OrderPlatformModel.d.ts +12 -0
- package/sdk/platform/Order/OrderPlatformModel.js +12 -0
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +27 -1
- package/sdk/platform/Payment/PaymentPlatformModel.js +19 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +7 -6
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +11 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +170 -33
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +171 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +4 -4
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +4 -4
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.js +19 -6
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +13 -3
- package/sdk/platform/Share/SharePlatformApplicationValidator.js +6 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +83 -13
- package/sdk/platform/User/UserPlatformModel.js +82 -12
|
@@ -382,21 +382,6 @@ export = ServiceabilityPlatformModel;
|
|
|
382
382
|
* @property {ServiceabilityPageResponse} page
|
|
383
383
|
* @property {ItemResponse[]} [items]
|
|
384
384
|
*/
|
|
385
|
-
/**
|
|
386
|
-
* @typedef ReAssignStoreRequest
|
|
387
|
-
* @property {string} to_pincode
|
|
388
|
-
* @property {string} identifier
|
|
389
|
-
* @property {Object} configuration
|
|
390
|
-
* @property {string[]} ignored_locations
|
|
391
|
-
* @property {Object[]} articles
|
|
392
|
-
*/
|
|
393
|
-
/**
|
|
394
|
-
* @typedef ReAssignStoreResponse
|
|
395
|
-
* @property {string} to_pincode
|
|
396
|
-
* @property {boolean} success
|
|
397
|
-
* @property {Object} error
|
|
398
|
-
* @property {Object[]} [articles]
|
|
399
|
-
*/
|
|
400
385
|
/**
|
|
401
386
|
* @typedef PincodeMopData
|
|
402
387
|
* @property {number[]} pincodes
|
|
@@ -937,10 +922,77 @@ export = ServiceabilityPlatformModel;
|
|
|
937
922
|
* @typedef RulePriorityResponse
|
|
938
923
|
* @property {boolean} [success]
|
|
939
924
|
*/
|
|
925
|
+
/**
|
|
926
|
+
* @typedef ArticleAssignment
|
|
927
|
+
* @property {string} [level]
|
|
928
|
+
* @property {string} [strategy] - The strategy parameter allows users to
|
|
929
|
+
* specify the desired approach or criteria for selecting optimal locations.
|
|
930
|
+
*/
|
|
931
|
+
/**
|
|
932
|
+
* @typedef ServiceabilityLocation
|
|
933
|
+
* @property {string} longitude - The longitude of the serviceability location.
|
|
934
|
+
* @property {string} latitude - The latitude of the serviceability location.
|
|
935
|
+
*/
|
|
936
|
+
/**
|
|
937
|
+
* @typedef LocationDetailsServiceability
|
|
938
|
+
* @property {string} [pincode] - The pincode of the serviceability location.
|
|
939
|
+
* @property {string} [sector] - The sector of the serviceability location.
|
|
940
|
+
* @property {string} [state] - The state of the serviceability location.
|
|
941
|
+
* @property {string} country - The country of the serviceability location.
|
|
942
|
+
* @property {string} [city] - The city of the serviceability location.
|
|
943
|
+
* @property {string} country_iso_code - The ISO code of the country.
|
|
944
|
+
* @property {ServiceabilityLocation} [location]
|
|
945
|
+
*/
|
|
946
|
+
/**
|
|
947
|
+
* @typedef OptimalLocationsArticles
|
|
948
|
+
* @property {number} item_id
|
|
949
|
+
* @property {string} size
|
|
950
|
+
* @property {string} quantity
|
|
951
|
+
* @property {string} [group_id]
|
|
952
|
+
* @property {boolean} [is_primary_item]
|
|
953
|
+
* @property {Object} [meta]
|
|
954
|
+
* @property {ArticleAssignment} article_assignment
|
|
955
|
+
* @property {number[]} ignore_locations
|
|
956
|
+
* @property {number[]} assign_locations
|
|
957
|
+
* @property {number} [seller_id]
|
|
958
|
+
*/
|
|
959
|
+
/**
|
|
960
|
+
* @typedef OptimlLocationsRequestSchema
|
|
961
|
+
* @property {string} channel_id
|
|
962
|
+
* @property {string} channel_type
|
|
963
|
+
* @property {LocationDetailsServiceability} to_serviceability
|
|
964
|
+
* @property {OptimalLocationsArticles} [article]
|
|
965
|
+
*/
|
|
966
|
+
/**
|
|
967
|
+
* @typedef OptimalLocationArticlesResponse
|
|
968
|
+
* @property {number} item_id
|
|
969
|
+
* @property {string} size
|
|
970
|
+
* @property {number} quantity
|
|
971
|
+
* @property {string} [group_id]
|
|
972
|
+
* @property {boolean} [is_primary_item]
|
|
973
|
+
* @property {Object} [meta]
|
|
974
|
+
* @property {ArticleAssignment} article_assignment
|
|
975
|
+
* @property {number} [seller_id]
|
|
976
|
+
* @property {number[]} ignore_locations
|
|
977
|
+
* @property {number[]} assign_locations
|
|
978
|
+
* @property {number} price_effective
|
|
979
|
+
* @property {number} mto_quantity
|
|
980
|
+
* @property {string} _id
|
|
981
|
+
* @property {string} uid
|
|
982
|
+
*/
|
|
983
|
+
/**
|
|
984
|
+
* @typedef OptimalLocationAssignedStoresResponse
|
|
985
|
+
* @property {number} store_id
|
|
986
|
+
* @property {OptimalLocationArticlesResponse[]} articles
|
|
987
|
+
*/
|
|
988
|
+
/**
|
|
989
|
+
* @typedef OptimalLocationsResponse
|
|
990
|
+
* @property {OptimalLocationAssignedStoresResponse[]} assigned_stores
|
|
991
|
+
*/
|
|
940
992
|
declare class ServiceabilityPlatformModel {
|
|
941
993
|
}
|
|
942
994
|
declare namespace ServiceabilityPlatformModel {
|
|
943
|
-
export { UpdateZoneConfigRequest, ServiceabilityErrorResponse, ApplicationServiceabilityConfig, ApplicationServiceabilityConfigResponse, EntityRegionView_Request, EntityRegionView_Error, EntityRegionView_page, getAppRegionZonesResponse, PageSchema, EntityRegionView_Items, EntityRegionView_Response, ListViewSummary, ZoneDataItem, ListViewProduct, ListViewChannels, ListViewItems, ListViewResponse, CompanyStoreView_PageItems, CompanyStoreView_Response, GetZoneDataViewChannels, ZoneProductTypes, ZoneMappingType, UpdateZoneData, ZoneUpdateRequest, ZoneSuccessResponse, GetZoneDataViewItems, GetSingleZoneDataViewResponse, GetZoneByIdSchema, CreateZoneData, ZoneResponse, GetZoneFromPincodeViewRequest, Zone, GetZoneFromPincodeViewResponse, GetZoneFromApplicationIdViewResponse, ServiceabilityPageResponse, MobileNo, ManagerResponse, ModifiedByResponse, IntegrationTypeResponse, ProductReturnConfigResponse, ContactNumberResponse, AddressResponse, CreatedByResponse, EwayBillResponse, EinvoiceResponse, GstCredentialsResponse, WarningsResponse, OpeningClosing, TimmingResponse, DocumentsResponse, Dp, LogisticsResponse, ItemResponse, GetStoresViewResponse,
|
|
995
|
+
export { UpdateZoneConfigRequest, ServiceabilityErrorResponse, ApplicationServiceabilityConfig, ApplicationServiceabilityConfigResponse, EntityRegionView_Request, EntityRegionView_Error, EntityRegionView_page, getAppRegionZonesResponse, PageSchema, EntityRegionView_Items, EntityRegionView_Response, ListViewSummary, ZoneDataItem, ListViewProduct, ListViewChannels, ListViewItems, ListViewResponse, CompanyStoreView_PageItems, CompanyStoreView_Response, GetZoneDataViewChannels, ZoneProductTypes, ZoneMappingType, UpdateZoneData, ZoneUpdateRequest, ZoneSuccessResponse, GetZoneDataViewItems, GetSingleZoneDataViewResponse, GetZoneByIdSchema, CreateZoneData, ZoneResponse, GetZoneFromPincodeViewRequest, Zone, GetZoneFromPincodeViewResponse, GetZoneFromApplicationIdViewResponse, ServiceabilityPageResponse, MobileNo, ManagerResponse, ModifiedByResponse, IntegrationTypeResponse, ProductReturnConfigResponse, ContactNumberResponse, AddressResponse, CreatedByResponse, EwayBillResponse, EinvoiceResponse, GstCredentialsResponse, WarningsResponse, OpeningClosing, TimmingResponse, DocumentsResponse, Dp, LogisticsResponse, ItemResponse, GetStoresViewResponse, PincodeMopData, PincodeMopUpdateResponse, PincodeMOPresponse, CommonError, PincodeMopBulkData, PincodeBulkViewResponse, PincodeCodStatusListingRequest, PincodeCodStatusListingResponse, Error, PincodeCodStatusListingPage, PincodeCodStatusListingSummary, PincodeMopUpdateAuditHistoryRequest, PincodeMopUpdateAuditHistoryPaging, PincodeMopUpdateAuditHistoryResponse, PincodeMopUpdateAuditHistoryResponseData, ArithmeticOperations, SchemeRulesFeatures, SchemeRules, CourierAccount, ErrorResponse, CourierPartnerAccountFailureResponse, Page, CourierPartnerList, LocationRuleValues, LocationRule, StringComparisonOperations, IntComparisonOperations, CourierPartnerRuleConditions, CourierPartnerRule, FailureResponse, CourierPartnerRulesListResponse, CompanyConfig, ZoneConfig, ApplicationConfig, BulkRegionJobSerializer, BulkRegionResponseItemData, BulkRegionResponse, SelfShipResponse, ApplicationSelfShipConfig, ApplicationSelfShipConfigResponse, StoreRuleConfigData, CustomerRadiusSchema, StoreRuleConditionSchema, StoreRuleDataSchema, StorePrioritySchema, GetStoreRulesApiResponse, CreateStoreRuleRequestSchema, StoreRuleResponseSchema, StoreRuleUpdateResponseSchema, ServiceabilityModel, CourierPartnerSchemeFeatures, CourierPartnerSchemeModel, CourierAccountResponse, CompanyCourierPartnerAccountListResponse, PackageMaterial, PackageMaterialResponse, PackageMaterialRule, PackageRule, PackageRuleResponse, Channel, PackageMaterialRuleList, PackageMaterialList, PackageRuleProduct, PackageRuleProductTag, PackageRuleCategory, PackageMaterialRuleQuantity, RulePriorityRequest, RulePriorityResponse, ArticleAssignment, ServiceabilityLocation, LocationDetailsServiceability, OptimalLocationsArticles, OptimlLocationsRequestSchema, OptimalLocationArticlesResponse, OptimalLocationAssignedStoresResponse, OptimalLocationsResponse };
|
|
944
996
|
}
|
|
945
997
|
/** @returns {UpdateZoneConfigRequest} */
|
|
946
998
|
declare function UpdateZoneConfigRequest(): UpdateZoneConfigRequest;
|
|
@@ -1379,23 +1431,6 @@ type GetStoresViewResponse = {
|
|
|
1379
1431
|
page: ServiceabilityPageResponse;
|
|
1380
1432
|
items?: ItemResponse[];
|
|
1381
1433
|
};
|
|
1382
|
-
/** @returns {ReAssignStoreRequest} */
|
|
1383
|
-
declare function ReAssignStoreRequest(): ReAssignStoreRequest;
|
|
1384
|
-
type ReAssignStoreRequest = {
|
|
1385
|
-
to_pincode: string;
|
|
1386
|
-
identifier: string;
|
|
1387
|
-
configuration: any;
|
|
1388
|
-
ignored_locations: string[];
|
|
1389
|
-
articles: any[];
|
|
1390
|
-
};
|
|
1391
|
-
/** @returns {ReAssignStoreResponse} */
|
|
1392
|
-
declare function ReAssignStoreResponse(): ReAssignStoreResponse;
|
|
1393
|
-
type ReAssignStoreResponse = {
|
|
1394
|
-
to_pincode: string;
|
|
1395
|
-
success: boolean;
|
|
1396
|
-
error: any;
|
|
1397
|
-
articles?: any[];
|
|
1398
|
-
};
|
|
1399
1434
|
/** @returns {PincodeMopData} */
|
|
1400
1435
|
declare function PincodeMopData(): PincodeMopData;
|
|
1401
1436
|
type PincodeMopData = {
|
|
@@ -2004,3 +2039,105 @@ declare function RulePriorityResponse(): RulePriorityResponse;
|
|
|
2004
2039
|
type RulePriorityResponse = {
|
|
2005
2040
|
success?: boolean;
|
|
2006
2041
|
};
|
|
2042
|
+
/** @returns {ArticleAssignment} */
|
|
2043
|
+
declare function ArticleAssignment(): ArticleAssignment;
|
|
2044
|
+
type ArticleAssignment = {
|
|
2045
|
+
level?: string;
|
|
2046
|
+
/**
|
|
2047
|
+
* - The strategy parameter allows users to
|
|
2048
|
+
* specify the desired approach or criteria for selecting optimal locations.
|
|
2049
|
+
*/
|
|
2050
|
+
strategy?: string;
|
|
2051
|
+
};
|
|
2052
|
+
/** @returns {ServiceabilityLocation} */
|
|
2053
|
+
declare function ServiceabilityLocation(): ServiceabilityLocation;
|
|
2054
|
+
type ServiceabilityLocation = {
|
|
2055
|
+
/**
|
|
2056
|
+
* - The longitude of the serviceability location.
|
|
2057
|
+
*/
|
|
2058
|
+
longitude: string;
|
|
2059
|
+
/**
|
|
2060
|
+
* - The latitude of the serviceability location.
|
|
2061
|
+
*/
|
|
2062
|
+
latitude: string;
|
|
2063
|
+
};
|
|
2064
|
+
/** @returns {LocationDetailsServiceability} */
|
|
2065
|
+
declare function LocationDetailsServiceability(): LocationDetailsServiceability;
|
|
2066
|
+
type LocationDetailsServiceability = {
|
|
2067
|
+
/**
|
|
2068
|
+
* - The pincode of the serviceability location.
|
|
2069
|
+
*/
|
|
2070
|
+
pincode?: string;
|
|
2071
|
+
/**
|
|
2072
|
+
* - The sector of the serviceability location.
|
|
2073
|
+
*/
|
|
2074
|
+
sector?: string;
|
|
2075
|
+
/**
|
|
2076
|
+
* - The state of the serviceability location.
|
|
2077
|
+
*/
|
|
2078
|
+
state?: string;
|
|
2079
|
+
/**
|
|
2080
|
+
* - The country of the serviceability location.
|
|
2081
|
+
*/
|
|
2082
|
+
country: string;
|
|
2083
|
+
/**
|
|
2084
|
+
* - The city of the serviceability location.
|
|
2085
|
+
*/
|
|
2086
|
+
city?: string;
|
|
2087
|
+
/**
|
|
2088
|
+
* - The ISO code of the country.
|
|
2089
|
+
*/
|
|
2090
|
+
country_iso_code: string;
|
|
2091
|
+
location?: ServiceabilityLocation;
|
|
2092
|
+
};
|
|
2093
|
+
/** @returns {OptimalLocationsArticles} */
|
|
2094
|
+
declare function OptimalLocationsArticles(): OptimalLocationsArticles;
|
|
2095
|
+
type OptimalLocationsArticles = {
|
|
2096
|
+
item_id: number;
|
|
2097
|
+
size: string;
|
|
2098
|
+
quantity: string;
|
|
2099
|
+
group_id?: string;
|
|
2100
|
+
is_primary_item?: boolean;
|
|
2101
|
+
meta?: any;
|
|
2102
|
+
article_assignment: ArticleAssignment;
|
|
2103
|
+
ignore_locations: number[];
|
|
2104
|
+
assign_locations: number[];
|
|
2105
|
+
seller_id?: number;
|
|
2106
|
+
};
|
|
2107
|
+
/** @returns {OptimlLocationsRequestSchema} */
|
|
2108
|
+
declare function OptimlLocationsRequestSchema(): OptimlLocationsRequestSchema;
|
|
2109
|
+
type OptimlLocationsRequestSchema = {
|
|
2110
|
+
channel_id: string;
|
|
2111
|
+
channel_type: string;
|
|
2112
|
+
to_serviceability: LocationDetailsServiceability;
|
|
2113
|
+
article?: OptimalLocationsArticles;
|
|
2114
|
+
};
|
|
2115
|
+
/** @returns {OptimalLocationArticlesResponse} */
|
|
2116
|
+
declare function OptimalLocationArticlesResponse(): OptimalLocationArticlesResponse;
|
|
2117
|
+
type OptimalLocationArticlesResponse = {
|
|
2118
|
+
item_id: number;
|
|
2119
|
+
size: string;
|
|
2120
|
+
quantity: number;
|
|
2121
|
+
group_id?: string;
|
|
2122
|
+
is_primary_item?: boolean;
|
|
2123
|
+
meta?: any;
|
|
2124
|
+
article_assignment: ArticleAssignment;
|
|
2125
|
+
seller_id?: number;
|
|
2126
|
+
ignore_locations: number[];
|
|
2127
|
+
assign_locations: number[];
|
|
2128
|
+
price_effective: number;
|
|
2129
|
+
mto_quantity: number;
|
|
2130
|
+
_id: string;
|
|
2131
|
+
uid: string;
|
|
2132
|
+
};
|
|
2133
|
+
/** @returns {OptimalLocationAssignedStoresResponse} */
|
|
2134
|
+
declare function OptimalLocationAssignedStoresResponse(): OptimalLocationAssignedStoresResponse;
|
|
2135
|
+
type OptimalLocationAssignedStoresResponse = {
|
|
2136
|
+
store_id: number;
|
|
2137
|
+
articles: OptimalLocationArticlesResponse[];
|
|
2138
|
+
};
|
|
2139
|
+
/** @returns {OptimalLocationsResponse} */
|
|
2140
|
+
declare function OptimalLocationsResponse(): OptimalLocationsResponse;
|
|
2141
|
+
type OptimalLocationsResponse = {
|
|
2142
|
+
assigned_stores: OptimalLocationAssignedStoresResponse[];
|
|
2143
|
+
};
|
|
@@ -437,23 +437,6 @@ const Joi = require("joi");
|
|
|
437
437
|
* @property {ItemResponse[]} [items]
|
|
438
438
|
*/
|
|
439
439
|
|
|
440
|
-
/**
|
|
441
|
-
* @typedef ReAssignStoreRequest
|
|
442
|
-
* @property {string} to_pincode
|
|
443
|
-
* @property {string} identifier
|
|
444
|
-
* @property {Object} configuration
|
|
445
|
-
* @property {string[]} ignored_locations
|
|
446
|
-
* @property {Object[]} articles
|
|
447
|
-
*/
|
|
448
|
-
|
|
449
|
-
/**
|
|
450
|
-
* @typedef ReAssignStoreResponse
|
|
451
|
-
* @property {string} to_pincode
|
|
452
|
-
* @property {boolean} success
|
|
453
|
-
* @property {Object} error
|
|
454
|
-
* @property {Object[]} [articles]
|
|
455
|
-
*/
|
|
456
|
-
|
|
457
440
|
/**
|
|
458
441
|
* @typedef PincodeMopData
|
|
459
442
|
* @property {number[]} pincodes
|
|
@@ -1062,6 +1045,81 @@ const Joi = require("joi");
|
|
|
1062
1045
|
* @property {boolean} [success]
|
|
1063
1046
|
*/
|
|
1064
1047
|
|
|
1048
|
+
/**
|
|
1049
|
+
* @typedef ArticleAssignment
|
|
1050
|
+
* @property {string} [level]
|
|
1051
|
+
* @property {string} [strategy] - The strategy parameter allows users to
|
|
1052
|
+
* specify the desired approach or criteria for selecting optimal locations.
|
|
1053
|
+
*/
|
|
1054
|
+
|
|
1055
|
+
/**
|
|
1056
|
+
* @typedef ServiceabilityLocation
|
|
1057
|
+
* @property {string} longitude - The longitude of the serviceability location.
|
|
1058
|
+
* @property {string} latitude - The latitude of the serviceability location.
|
|
1059
|
+
*/
|
|
1060
|
+
|
|
1061
|
+
/**
|
|
1062
|
+
* @typedef LocationDetailsServiceability
|
|
1063
|
+
* @property {string} [pincode] - The pincode of the serviceability location.
|
|
1064
|
+
* @property {string} [sector] - The sector of the serviceability location.
|
|
1065
|
+
* @property {string} [state] - The state of the serviceability location.
|
|
1066
|
+
* @property {string} country - The country of the serviceability location.
|
|
1067
|
+
* @property {string} [city] - The city of the serviceability location.
|
|
1068
|
+
* @property {string} country_iso_code - The ISO code of the country.
|
|
1069
|
+
* @property {ServiceabilityLocation} [location]
|
|
1070
|
+
*/
|
|
1071
|
+
|
|
1072
|
+
/**
|
|
1073
|
+
* @typedef OptimalLocationsArticles
|
|
1074
|
+
* @property {number} item_id
|
|
1075
|
+
* @property {string} size
|
|
1076
|
+
* @property {string} quantity
|
|
1077
|
+
* @property {string} [group_id]
|
|
1078
|
+
* @property {boolean} [is_primary_item]
|
|
1079
|
+
* @property {Object} [meta]
|
|
1080
|
+
* @property {ArticleAssignment} article_assignment
|
|
1081
|
+
* @property {number[]} ignore_locations
|
|
1082
|
+
* @property {number[]} assign_locations
|
|
1083
|
+
* @property {number} [seller_id]
|
|
1084
|
+
*/
|
|
1085
|
+
|
|
1086
|
+
/**
|
|
1087
|
+
* @typedef OptimlLocationsRequestSchema
|
|
1088
|
+
* @property {string} channel_id
|
|
1089
|
+
* @property {string} channel_type
|
|
1090
|
+
* @property {LocationDetailsServiceability} to_serviceability
|
|
1091
|
+
* @property {OptimalLocationsArticles} [article]
|
|
1092
|
+
*/
|
|
1093
|
+
|
|
1094
|
+
/**
|
|
1095
|
+
* @typedef OptimalLocationArticlesResponse
|
|
1096
|
+
* @property {number} item_id
|
|
1097
|
+
* @property {string} size
|
|
1098
|
+
* @property {number} quantity
|
|
1099
|
+
* @property {string} [group_id]
|
|
1100
|
+
* @property {boolean} [is_primary_item]
|
|
1101
|
+
* @property {Object} [meta]
|
|
1102
|
+
* @property {ArticleAssignment} article_assignment
|
|
1103
|
+
* @property {number} [seller_id]
|
|
1104
|
+
* @property {number[]} ignore_locations
|
|
1105
|
+
* @property {number[]} assign_locations
|
|
1106
|
+
* @property {number} price_effective
|
|
1107
|
+
* @property {number} mto_quantity
|
|
1108
|
+
* @property {string} _id
|
|
1109
|
+
* @property {string} uid
|
|
1110
|
+
*/
|
|
1111
|
+
|
|
1112
|
+
/**
|
|
1113
|
+
* @typedef OptimalLocationAssignedStoresResponse
|
|
1114
|
+
* @property {number} store_id
|
|
1115
|
+
* @property {OptimalLocationArticlesResponse[]} articles
|
|
1116
|
+
*/
|
|
1117
|
+
|
|
1118
|
+
/**
|
|
1119
|
+
* @typedef OptimalLocationsResponse
|
|
1120
|
+
* @property {OptimalLocationAssignedStoresResponse[]} assigned_stores
|
|
1121
|
+
*/
|
|
1122
|
+
|
|
1065
1123
|
class ServiceabilityPlatformModel {
|
|
1066
1124
|
/** @returns {UpdateZoneConfigRequest} */
|
|
1067
1125
|
static UpdateZoneConfigRequest() {
|
|
@@ -1644,27 +1702,6 @@ class ServiceabilityPlatformModel {
|
|
|
1644
1702
|
});
|
|
1645
1703
|
}
|
|
1646
1704
|
|
|
1647
|
-
/** @returns {ReAssignStoreRequest} */
|
|
1648
|
-
static ReAssignStoreRequest() {
|
|
1649
|
-
return Joi.object({
|
|
1650
|
-
to_pincode: Joi.string().allow("").required(),
|
|
1651
|
-
identifier: Joi.string().allow("").required(),
|
|
1652
|
-
configuration: Joi.any().required(),
|
|
1653
|
-
ignored_locations: Joi.array().items(Joi.string().allow("")).required(),
|
|
1654
|
-
articles: Joi.array().items(Joi.any()).required(),
|
|
1655
|
-
});
|
|
1656
|
-
}
|
|
1657
|
-
|
|
1658
|
-
/** @returns {ReAssignStoreResponse} */
|
|
1659
|
-
static ReAssignStoreResponse() {
|
|
1660
|
-
return Joi.object({
|
|
1661
|
-
to_pincode: Joi.string().allow("").required(),
|
|
1662
|
-
success: Joi.boolean().required(),
|
|
1663
|
-
error: Joi.any().required(),
|
|
1664
|
-
articles: Joi.array().items(Joi.any()),
|
|
1665
|
-
});
|
|
1666
|
-
}
|
|
1667
|
-
|
|
1668
1705
|
/** @returns {PincodeMopData} */
|
|
1669
1706
|
static PincodeMopData() {
|
|
1670
1707
|
return Joi.object({
|
|
@@ -2450,5 +2487,101 @@ class ServiceabilityPlatformModel {
|
|
|
2450
2487
|
success: Joi.boolean(),
|
|
2451
2488
|
});
|
|
2452
2489
|
}
|
|
2490
|
+
|
|
2491
|
+
/** @returns {ArticleAssignment} */
|
|
2492
|
+
static ArticleAssignment() {
|
|
2493
|
+
return Joi.object({
|
|
2494
|
+
level: Joi.string().allow(""),
|
|
2495
|
+
strategy: Joi.string().allow(""),
|
|
2496
|
+
});
|
|
2497
|
+
}
|
|
2498
|
+
|
|
2499
|
+
/** @returns {ServiceabilityLocation} */
|
|
2500
|
+
static ServiceabilityLocation() {
|
|
2501
|
+
return Joi.object({
|
|
2502
|
+
longitude: Joi.string().allow("").required(),
|
|
2503
|
+
latitude: Joi.string().allow("").required(),
|
|
2504
|
+
});
|
|
2505
|
+
}
|
|
2506
|
+
|
|
2507
|
+
/** @returns {LocationDetailsServiceability} */
|
|
2508
|
+
static LocationDetailsServiceability() {
|
|
2509
|
+
return Joi.object({
|
|
2510
|
+
pincode: Joi.string().allow(""),
|
|
2511
|
+
sector: Joi.string().allow(""),
|
|
2512
|
+
state: Joi.string().allow(""),
|
|
2513
|
+
country: Joi.string().allow("").required(),
|
|
2514
|
+
city: Joi.string().allow(""),
|
|
2515
|
+
country_iso_code: Joi.string().allow("").required(),
|
|
2516
|
+
location: ServiceabilityPlatformModel.ServiceabilityLocation(),
|
|
2517
|
+
});
|
|
2518
|
+
}
|
|
2519
|
+
|
|
2520
|
+
/** @returns {OptimalLocationsArticles} */
|
|
2521
|
+
static OptimalLocationsArticles() {
|
|
2522
|
+
return Joi.object({
|
|
2523
|
+
item_id: Joi.number().required(),
|
|
2524
|
+
size: Joi.string().allow("").required(),
|
|
2525
|
+
quantity: Joi.string().allow("").required(),
|
|
2526
|
+
group_id: Joi.string().allow(""),
|
|
2527
|
+
is_primary_item: Joi.boolean(),
|
|
2528
|
+
meta: Joi.any(),
|
|
2529
|
+
article_assignment: ServiceabilityPlatformModel.ArticleAssignment().required(),
|
|
2530
|
+
ignore_locations: Joi.array().items(Joi.number()).required(),
|
|
2531
|
+
assign_locations: Joi.array().items(Joi.number()).required(),
|
|
2532
|
+
seller_id: Joi.number(),
|
|
2533
|
+
});
|
|
2534
|
+
}
|
|
2535
|
+
|
|
2536
|
+
/** @returns {OptimlLocationsRequestSchema} */
|
|
2537
|
+
static OptimlLocationsRequestSchema() {
|
|
2538
|
+
return Joi.object({
|
|
2539
|
+
channel_id: Joi.string().allow("").required(),
|
|
2540
|
+
channel_type: Joi.string().allow("").required(),
|
|
2541
|
+
to_serviceability: ServiceabilityPlatformModel.LocationDetailsServiceability().required(),
|
|
2542
|
+
article: ServiceabilityPlatformModel.OptimalLocationsArticles(),
|
|
2543
|
+
});
|
|
2544
|
+
}
|
|
2545
|
+
|
|
2546
|
+
/** @returns {OptimalLocationArticlesResponse} */
|
|
2547
|
+
static OptimalLocationArticlesResponse() {
|
|
2548
|
+
return Joi.object({
|
|
2549
|
+
item_id: Joi.number().required(),
|
|
2550
|
+
size: Joi.string().allow("").required(),
|
|
2551
|
+
quantity: Joi.number().required(),
|
|
2552
|
+
group_id: Joi.string().allow(""),
|
|
2553
|
+
is_primary_item: Joi.boolean(),
|
|
2554
|
+
meta: Joi.any(),
|
|
2555
|
+
article_assignment: ServiceabilityPlatformModel.ArticleAssignment().required(),
|
|
2556
|
+
seller_id: Joi.number(),
|
|
2557
|
+
ignore_locations: Joi.array().items(Joi.number()).required(),
|
|
2558
|
+
assign_locations: Joi.array().items(Joi.number()).required(),
|
|
2559
|
+
price_effective: Joi.number().required(),
|
|
2560
|
+
mto_quantity: Joi.number().required(),
|
|
2561
|
+
_id: Joi.string().allow("").required(),
|
|
2562
|
+
uid: Joi.string().allow("").required(),
|
|
2563
|
+
});
|
|
2564
|
+
}
|
|
2565
|
+
|
|
2566
|
+
/** @returns {OptimalLocationAssignedStoresResponse} */
|
|
2567
|
+
static OptimalLocationAssignedStoresResponse() {
|
|
2568
|
+
return Joi.object({
|
|
2569
|
+
store_id: Joi.number().required(),
|
|
2570
|
+
articles: Joi.array()
|
|
2571
|
+
.items(ServiceabilityPlatformModel.OptimalLocationArticlesResponse())
|
|
2572
|
+
.required(),
|
|
2573
|
+
});
|
|
2574
|
+
}
|
|
2575
|
+
|
|
2576
|
+
/** @returns {OptimalLocationsResponse} */
|
|
2577
|
+
static OptimalLocationsResponse() {
|
|
2578
|
+
return Joi.object({
|
|
2579
|
+
assigned_stores: Joi.array()
|
|
2580
|
+
.items(
|
|
2581
|
+
ServiceabilityPlatformModel.OptimalLocationAssignedStoresResponse()
|
|
2582
|
+
)
|
|
2583
|
+
.required(),
|
|
2584
|
+
});
|
|
2585
|
+
}
|
|
2453
2586
|
}
|
|
2454
2587
|
module.exports = ServiceabilityPlatformModel;
|
|
@@ -71,7 +71,7 @@ export = ServiceabilityPlatformValidator;
|
|
|
71
71
|
*/
|
|
72
72
|
/**
|
|
73
73
|
* @typedef GetOptimalLocationsParam
|
|
74
|
-
* @property {ServiceabilityPlatformModel.
|
|
74
|
+
* @property {ServiceabilityPlatformModel.OptimlLocationsRequestSchema} body
|
|
75
75
|
*/
|
|
76
76
|
/**
|
|
77
77
|
* @typedef GetPackageMaterialListParam
|
|
@@ -114,7 +114,7 @@ export = ServiceabilityPlatformValidator;
|
|
|
114
114
|
* @property {boolean} [isActive] - Status of Zone (either active or inactive)
|
|
115
115
|
* @property {string} [channelId] - Zones filtered by an application
|
|
116
116
|
* @property {string} [q] - Search with name as a free text
|
|
117
|
-
* @property {string} [
|
|
117
|
+
* @property {string} [countryIsoCode] - ISO2 code of the country
|
|
118
118
|
* @property {string} [state] - State name
|
|
119
119
|
* @property {string} [city] - City name
|
|
120
120
|
* @property {string} [pincode] - Pincode value to search zones
|
|
@@ -365,7 +365,7 @@ type GetCourierPartnerAccountsParam = {
|
|
|
365
365
|
transportType?: string;
|
|
366
366
|
};
|
|
367
367
|
type GetOptimalLocationsParam = {
|
|
368
|
-
body: ServiceabilityPlatformModel.
|
|
368
|
+
body: ServiceabilityPlatformModel.OptimlLocationsRequestSchema;
|
|
369
369
|
};
|
|
370
370
|
type GetPackageMaterialListParam = {
|
|
371
371
|
/**
|
|
@@ -461,7 +461,7 @@ type GetZonesParam = {
|
|
|
461
461
|
/**
|
|
462
462
|
* - ISO2 code of the country
|
|
463
463
|
*/
|
|
464
|
-
|
|
464
|
+
countryIsoCode?: string;
|
|
465
465
|
/**
|
|
466
466
|
* - State name
|
|
467
467
|
*/
|
|
@@ -86,7 +86,7 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
86
86
|
|
|
87
87
|
/**
|
|
88
88
|
* @typedef GetOptimalLocationsParam
|
|
89
|
-
* @property {ServiceabilityPlatformModel.
|
|
89
|
+
* @property {ServiceabilityPlatformModel.OptimlLocationsRequestSchema} body
|
|
90
90
|
*/
|
|
91
91
|
|
|
92
92
|
/**
|
|
@@ -136,7 +136,7 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
136
136
|
* @property {boolean} [isActive] - Status of Zone (either active or inactive)
|
|
137
137
|
* @property {string} [channelId] - Zones filtered by an application
|
|
138
138
|
* @property {string} [q] - Search with name as a free text
|
|
139
|
-
* @property {string} [
|
|
139
|
+
* @property {string} [countryIsoCode] - ISO2 code of the country
|
|
140
140
|
* @property {string} [state] - State name
|
|
141
141
|
* @property {string} [city] - City name
|
|
142
142
|
* @property {string} [pincode] - Pincode value to search zones
|
|
@@ -294,7 +294,7 @@ class ServiceabilityPlatformValidator {
|
|
|
294
294
|
/** @returns {GetOptimalLocationsParam} */
|
|
295
295
|
static getOptimalLocations() {
|
|
296
296
|
return Joi.object({
|
|
297
|
-
body: ServiceabilityPlatformModel.
|
|
297
|
+
body: ServiceabilityPlatformModel.OptimlLocationsRequestSchema().required(),
|
|
298
298
|
}).required();
|
|
299
299
|
}
|
|
300
300
|
|
|
@@ -356,7 +356,7 @@ class ServiceabilityPlatformValidator {
|
|
|
356
356
|
isActive: Joi.boolean(),
|
|
357
357
|
channelId: Joi.string().allow(""),
|
|
358
358
|
q: Joi.string().allow(""),
|
|
359
|
-
|
|
359
|
+
countryIsoCode: Joi.string().allow(""),
|
|
360
360
|
state: Joi.string().allow(""),
|
|
361
361
|
city: Joi.string().allow(""),
|
|
362
362
|
pincode: Joi.string().allow(""),
|
|
@@ -44,7 +44,7 @@ declare class Share {
|
|
|
44
44
|
* @summary: Get short links
|
|
45
45
|
* @description: Get short links - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinks/).
|
|
46
46
|
*/
|
|
47
|
-
getShortLinks({ pageNo, pageSize, createdBy, active,
|
|
47
|
+
getShortLinks({ pageNo, pageSize, createdBy, active, shortUrl, originalUrl, title, requestHeaders, }?: SharePlatformApplicationValidator.GetShortLinksParam, { responseHeaders }?: object): Promise<SharePlatformModel.ShortLinkList>;
|
|
48
48
|
/**
|
|
49
49
|
* @param {SharePlatformApplicationValidator.UpdateShortLinkByIdParam} arg
|
|
50
50
|
* - Arg object
|
|
@@ -261,9 +261,16 @@ class Share {
|
|
|
261
261
|
* @description: Get short links - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/share/getShortLinks/).
|
|
262
262
|
*/
|
|
263
263
|
async getShortLinks(
|
|
264
|
-
{
|
|
265
|
-
|
|
266
|
-
|
|
264
|
+
{
|
|
265
|
+
pageNo,
|
|
266
|
+
pageSize,
|
|
267
|
+
createdBy,
|
|
268
|
+
active,
|
|
269
|
+
shortUrl,
|
|
270
|
+
originalUrl,
|
|
271
|
+
title,
|
|
272
|
+
requestHeaders,
|
|
273
|
+
} = { requestHeaders: {} },
|
|
267
274
|
{ responseHeaders } = { responseHeaders: false }
|
|
268
275
|
) {
|
|
269
276
|
const {
|
|
@@ -274,7 +281,9 @@ class Share {
|
|
|
274
281
|
pageSize,
|
|
275
282
|
createdBy,
|
|
276
283
|
active,
|
|
277
|
-
|
|
284
|
+
shortUrl,
|
|
285
|
+
originalUrl,
|
|
286
|
+
title,
|
|
278
287
|
},
|
|
279
288
|
{ abortEarly: false, allowUnknown: true }
|
|
280
289
|
);
|
|
@@ -291,7 +300,9 @@ class Share {
|
|
|
291
300
|
pageSize,
|
|
292
301
|
createdBy,
|
|
293
302
|
active,
|
|
294
|
-
|
|
303
|
+
shortUrl,
|
|
304
|
+
originalUrl,
|
|
305
|
+
title,
|
|
295
306
|
},
|
|
296
307
|
{ abortEarly: false, allowUnknown: false }
|
|
297
308
|
);
|
|
@@ -307,7 +318,9 @@ class Share {
|
|
|
307
318
|
query_params["page_size"] = pageSize;
|
|
308
319
|
query_params["created_by"] = createdBy;
|
|
309
320
|
query_params["active"] = active;
|
|
310
|
-
query_params["
|
|
321
|
+
query_params["short_url"] = shortUrl;
|
|
322
|
+
query_params["original_url"] = originalUrl;
|
|
323
|
+
query_params["title"] = title;
|
|
311
324
|
|
|
312
325
|
const response = await PlatformAPIClient.execute(
|
|
313
326
|
this.config,
|
|
@@ -18,7 +18,9 @@ export = SharePlatformApplicationValidator;
|
|
|
18
18
|
* @property {number} [pageSize] - Current page size
|
|
19
19
|
* @property {string} [createdBy] - Short link creator
|
|
20
20
|
* @property {string} [active] - Short link active status
|
|
21
|
-
* @property {string} [
|
|
21
|
+
* @property {string} [shortUrl] - Search for short url
|
|
22
|
+
* @property {string} [originalUrl] - Search for original url
|
|
23
|
+
* @property {string} [title] - Search text for title
|
|
22
24
|
*/
|
|
23
25
|
/**
|
|
24
26
|
* @typedef UpdateShortLinkByIdParam
|
|
@@ -74,9 +76,17 @@ type GetShortLinksParam = {
|
|
|
74
76
|
*/
|
|
75
77
|
active?: string;
|
|
76
78
|
/**
|
|
77
|
-
* - Search
|
|
79
|
+
* - Search for short url
|
|
78
80
|
*/
|
|
79
|
-
|
|
81
|
+
shortUrl?: string;
|
|
82
|
+
/**
|
|
83
|
+
* - Search for original url
|
|
84
|
+
*/
|
|
85
|
+
originalUrl?: string;
|
|
86
|
+
/**
|
|
87
|
+
* - Search text for title
|
|
88
|
+
*/
|
|
89
|
+
title?: string;
|
|
80
90
|
};
|
|
81
91
|
type UpdateShortLinkByIdParam = {
|
|
82
92
|
/**
|
|
@@ -24,7 +24,9 @@ const SharePlatformModel = require("./SharePlatformModel");
|
|
|
24
24
|
* @property {number} [pageSize] - Current page size
|
|
25
25
|
* @property {string} [createdBy] - Short link creator
|
|
26
26
|
* @property {string} [active] - Short link active status
|
|
27
|
-
* @property {string} [
|
|
27
|
+
* @property {string} [shortUrl] - Search for short url
|
|
28
|
+
* @property {string} [originalUrl] - Search for original url
|
|
29
|
+
* @property {string} [title] - Search text for title
|
|
28
30
|
*/
|
|
29
31
|
|
|
30
32
|
/**
|
|
@@ -62,7 +64,9 @@ class SharePlatformApplicationValidator {
|
|
|
62
64
|
pageSize: Joi.number(),
|
|
63
65
|
createdBy: Joi.string().allow(""),
|
|
64
66
|
active: Joi.string().allow(""),
|
|
65
|
-
|
|
67
|
+
shortUrl: Joi.string().allow(""),
|
|
68
|
+
originalUrl: Joi.string().allow(""),
|
|
69
|
+
title: Joi.string().allow(""),
|
|
66
70
|
}).required();
|
|
67
71
|
}
|
|
68
72
|
|