@gofynd/fdk-client-javascript 3.4.3 → 3.5.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/common/AxiosHelper.js +1 -1
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +23 -6
- package/sdk/platform/Catalog/CatalogPlatformModel.js +11 -3
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +10 -0
- package/sdk/platform/Communication/CommunicationPlatformModel.js +4 -0
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +17 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +15 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +13 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +89 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +25 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +17 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +50 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +36 -0
package/README.md
CHANGED
|
@@ -234,7 +234,7 @@ console.log("Active Theme: ", response.information.name);
|
|
|
234
234
|
The above code will log the curl command in the console
|
|
235
235
|
|
|
236
236
|
```bash
|
|
237
|
-
curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.
|
|
237
|
+
curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 3.5.0' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
|
|
238
238
|
Active Theme: Emerge
|
|
239
239
|
```
|
|
240
240
|
|
package/package.json
CHANGED
|
@@ -2628,9 +2628,16 @@ export = CatalogPlatformModel;
|
|
|
2628
2628
|
/**
|
|
2629
2629
|
* @typedef LocationQuantityRequestSchema
|
|
2630
2630
|
* @property {string} [expiration_date] - The expiration date of the inventory item.
|
|
2631
|
-
* @property {number} [total_quantity] - The total quantity of the inventory
|
|
2632
|
-
*
|
|
2633
|
-
*
|
|
2631
|
+
* @property {number} [total_quantity] - The total quantity of the inventory
|
|
2632
|
+
* item. Any one of total_quantity, damaged_quantity, not_available_quantity
|
|
2633
|
+
* should be provided.
|
|
2634
|
+
* @property {number} [damaged_quantity] - The damaged quantity of the inventory
|
|
2635
|
+
* item. Any one of total_quantity, damaged_quantity, not_available_quantity
|
|
2636
|
+
* should be provided.
|
|
2637
|
+
* @property {number} [not_available_quantity] - The not available quantity of
|
|
2638
|
+
* the inventory item. Any one of total_quantity, damaged_quantity,
|
|
2639
|
+
* not_available_quantity should be provided.
|
|
2640
|
+
* @property {string} [mode] - Indicates whether delta or replace operation for inventory
|
|
2634
2641
|
*/
|
|
2635
2642
|
/**
|
|
2636
2643
|
* @typedef LocationPriceQuantitySuccessResponseSchema
|
|
@@ -10042,17 +10049,27 @@ type LocationQuantityRequestSchema = {
|
|
|
10042
10049
|
*/
|
|
10043
10050
|
expiration_date?: string;
|
|
10044
10051
|
/**
|
|
10045
|
-
* - The total quantity of the inventory
|
|
10052
|
+
* - The total quantity of the inventory
|
|
10053
|
+
* item. Any one of total_quantity, damaged_quantity, not_available_quantity
|
|
10054
|
+
* should be provided.
|
|
10046
10055
|
*/
|
|
10047
10056
|
total_quantity?: number;
|
|
10048
10057
|
/**
|
|
10049
|
-
* - The
|
|
10058
|
+
* - The damaged quantity of the inventory
|
|
10059
|
+
* item. Any one of total_quantity, damaged_quantity, not_available_quantity
|
|
10060
|
+
* should be provided.
|
|
10050
10061
|
*/
|
|
10051
10062
|
damaged_quantity?: number;
|
|
10052
10063
|
/**
|
|
10053
|
-
* - The
|
|
10064
|
+
* - The not available quantity of
|
|
10065
|
+
* the inventory item. Any one of total_quantity, damaged_quantity,
|
|
10066
|
+
* not_available_quantity should be provided.
|
|
10054
10067
|
*/
|
|
10055
10068
|
not_available_quantity?: number;
|
|
10069
|
+
/**
|
|
10070
|
+
* - Indicates whether delta or replace operation for inventory
|
|
10071
|
+
*/
|
|
10072
|
+
mode?: string;
|
|
10056
10073
|
};
|
|
10057
10074
|
/** @returns {LocationPriceQuantitySuccessResponseSchema} */
|
|
10058
10075
|
declare function LocationPriceQuantitySuccessResponseSchema(): LocationPriceQuantitySuccessResponseSchema;
|
|
@@ -2890,9 +2890,16 @@ const Joi = require("joi");
|
|
|
2890
2890
|
/**
|
|
2891
2891
|
* @typedef LocationQuantityRequestSchema
|
|
2892
2892
|
* @property {string} [expiration_date] - The expiration date of the inventory item.
|
|
2893
|
-
* @property {number} [total_quantity] - The total quantity of the inventory
|
|
2894
|
-
*
|
|
2895
|
-
*
|
|
2893
|
+
* @property {number} [total_quantity] - The total quantity of the inventory
|
|
2894
|
+
* item. Any one of total_quantity, damaged_quantity, not_available_quantity
|
|
2895
|
+
* should be provided.
|
|
2896
|
+
* @property {number} [damaged_quantity] - The damaged quantity of the inventory
|
|
2897
|
+
* item. Any one of total_quantity, damaged_quantity, not_available_quantity
|
|
2898
|
+
* should be provided.
|
|
2899
|
+
* @property {number} [not_available_quantity] - The not available quantity of
|
|
2900
|
+
* the inventory item. Any one of total_quantity, damaged_quantity,
|
|
2901
|
+
* not_available_quantity should be provided.
|
|
2902
|
+
* @property {string} [mode] - Indicates whether delta or replace operation for inventory
|
|
2896
2903
|
*/
|
|
2897
2904
|
|
|
2898
2905
|
/**
|
|
@@ -7961,6 +7968,7 @@ class CatalogPlatformModel {
|
|
|
7961
7968
|
total_quantity: Joi.number(),
|
|
7962
7969
|
damaged_quantity: Joi.number(),
|
|
7963
7970
|
not_available_quantity: Joi.number(),
|
|
7971
|
+
mode: Joi.string().allow(""),
|
|
7964
7972
|
});
|
|
7965
7973
|
}
|
|
7966
7974
|
|
|
@@ -114,6 +114,7 @@ export = CommunicationPlatformModel;
|
|
|
114
114
|
* @property {string} [name]
|
|
115
115
|
* @property {string} [file_url]
|
|
116
116
|
* @property {string} [type]
|
|
117
|
+
* @property {string} [datasource_type] - Type of the datasource (audience or user_group)
|
|
117
118
|
* @property {number} [records_count]
|
|
118
119
|
* @property {string} [application]
|
|
119
120
|
*/
|
|
@@ -147,6 +148,7 @@ export = CommunicationPlatformModel;
|
|
|
147
148
|
* @property {string} [_id]
|
|
148
149
|
* @property {string} [datasource]
|
|
149
150
|
* @property {string} [type]
|
|
151
|
+
* @property {string} [datasource_type] - Type of the datasource (audience or user_group)
|
|
150
152
|
* @property {string} [name]
|
|
151
153
|
* @property {string} [application]
|
|
152
154
|
* @property {string} [created_at]
|
|
@@ -1027,6 +1029,10 @@ type CampaignReq = {
|
|
|
1027
1029
|
name?: string;
|
|
1028
1030
|
file_url?: string;
|
|
1029
1031
|
type?: string;
|
|
1032
|
+
/**
|
|
1033
|
+
* - Type of the datasource (audience or user_group)
|
|
1034
|
+
*/
|
|
1035
|
+
datasource_type?: string;
|
|
1030
1036
|
records_count?: number;
|
|
1031
1037
|
application?: string;
|
|
1032
1038
|
};
|
|
@@ -1065,6 +1071,10 @@ type Campaign = {
|
|
|
1065
1071
|
_id?: string;
|
|
1066
1072
|
datasource?: string;
|
|
1067
1073
|
type?: string;
|
|
1074
|
+
/**
|
|
1075
|
+
* - Type of the datasource (audience or user_group)
|
|
1076
|
+
*/
|
|
1077
|
+
datasource_type?: string;
|
|
1068
1078
|
name?: string;
|
|
1069
1079
|
application?: string;
|
|
1070
1080
|
created_at?: string;
|
|
@@ -133,6 +133,7 @@ const Joi = require("joi");
|
|
|
133
133
|
* @property {string} [name]
|
|
134
134
|
* @property {string} [file_url]
|
|
135
135
|
* @property {string} [type]
|
|
136
|
+
* @property {string} [datasource_type] - Type of the datasource (audience or user_group)
|
|
136
137
|
* @property {number} [records_count]
|
|
137
138
|
* @property {string} [application]
|
|
138
139
|
*/
|
|
@@ -171,6 +172,7 @@ const Joi = require("joi");
|
|
|
171
172
|
* @property {string} [_id]
|
|
172
173
|
* @property {string} [datasource]
|
|
173
174
|
* @property {string} [type]
|
|
175
|
+
* @property {string} [datasource_type] - Type of the datasource (audience or user_group)
|
|
174
176
|
* @property {string} [name]
|
|
175
177
|
* @property {string} [application]
|
|
176
178
|
* @property {string} [created_at]
|
|
@@ -1178,6 +1180,7 @@ class CommunicationPlatformModel {
|
|
|
1178
1180
|
name: Joi.string().allow(""),
|
|
1179
1181
|
file_url: Joi.string().allow(""),
|
|
1180
1182
|
type: Joi.string().allow(""),
|
|
1183
|
+
datasource_type: Joi.string().allow(""),
|
|
1181
1184
|
records_count: Joi.number(),
|
|
1182
1185
|
application: Joi.string().allow(""),
|
|
1183
1186
|
});
|
|
@@ -1226,6 +1229,7 @@ class CommunicationPlatformModel {
|
|
|
1226
1229
|
_id: Joi.string().allow(""),
|
|
1227
1230
|
datasource: Joi.string().allow(""),
|
|
1228
1231
|
type: Joi.string().allow(""),
|
|
1232
|
+
datasource_type: Joi.string().allow(""),
|
|
1229
1233
|
name: Joi.string().allow(""),
|
|
1230
1234
|
application: Joi.string().allow(""),
|
|
1231
1235
|
created_at: Joi.string().allow(""),
|
|
@@ -59,6 +59,11 @@ export = ConfigurationPlatformModel;
|
|
|
59
59
|
* @property {boolean} [enabled] - Indicates whether search query interpretation
|
|
60
60
|
* is enabled for the application.
|
|
61
61
|
*/
|
|
62
|
+
/**
|
|
63
|
+
* @typedef SkgIdentification
|
|
64
|
+
* @property {boolean} [enabled] - Indicates whether semantic knowledge
|
|
65
|
+
* graph-based search is enabled for the application.
|
|
66
|
+
*/
|
|
62
67
|
/**
|
|
63
68
|
* @typedef QuerySuggestions
|
|
64
69
|
* @property {boolean} [enabled] - Indicates whether to enable or disable query
|
|
@@ -71,6 +76,7 @@ export = ConfigurationPlatformModel;
|
|
|
71
76
|
* @typedef SearchConfig
|
|
72
77
|
* @property {FstIdentification} [fst_identification]
|
|
73
78
|
* @property {QuerySuggestions} [query_suggestions]
|
|
79
|
+
* @property {SkgIdentification} [skg_identification]
|
|
74
80
|
*/
|
|
75
81
|
/**
|
|
76
82
|
* @typedef AppInventoryConfig
|
|
@@ -1409,7 +1415,7 @@ export = ConfigurationPlatformModel;
|
|
|
1409
1415
|
declare class ConfigurationPlatformModel {
|
|
1410
1416
|
}
|
|
1411
1417
|
declare namespace ConfigurationPlatformModel {
|
|
1412
|
-
export { CurrencyExchangeResponseV2, CurrencyExchangeItem, ApplicationInventory, PiiMasking, FstIdentification, QuerySuggestions, SearchConfig, AppInventoryConfig, InventoryBrand, InventoryStore, AppStoreRules, InventoryCategory, InventoryPrice, InventoryDiscount, AuthenticationConfig, ArticleAssignmentConfig, ArticleAssignmentRules, StorePriority, AppCartConfig, InternationalDeliveryCharges, DeliveryCharges, Charges, AppPaymentConfig, CallbackUrl, Methods, PaymentModeConfig, PaymentSelectionLock, AppOrderConfig, ProcessingSchedule, StartAfter, AppLogisticsConfig, LoyaltyPointsConfig, AppInventoryPartialUpdate, BrandCompanyInfo, CompanyByBrandsRequestSchema, CompanyByBrandsResponseSchema, StoreByBrandsRequestSchema, StoreByBrandsResponseSchema, BrandStoreInfo, CompanyBrandInfo, BrandsByCompanyResponseSchema, ValidationFailedResponseSchema, NotFound, CommunicationConfig, CommsConfig, PanCardConfig, CreateApplicationRequestSchema, CreateAppResponseSchema, ApplicationsResponseSchema, MobileAppConfiguration, LandingImage, SplashImage, MobileAppConfigRequestSchema, BuildVersionHistory, BuildVersion, AppSupportedCurrency, DefaultCurrency, DomainAdd, DomainAddRequestSchema, Domain, DomainsResponseSchema, UpdateDomain, UpdateDomainTypeRequestSchema, DomainStatusRequestSchema, DomainStatus, DomainStatusResponseSchema, DomainSuggestionsRequestSchema, DomainSuggestion, DomainSuggestionsResponseSchema, SuccessMessageResponseSchema, App, AppDomain, CompaniesResponseSchema, AppInventoryCompanies, StoresResponseSchema, AppInventoryStores, FilterOrderingStoreRequestSchema, DeploymentMeta, OrderingStoreConfig, OrderingStoreSelectRequestSchema, OrderingStoreSelect, OtherSellerCompany, OtherSellerApplication, OtherSellerApplications, OptedApplicationResponseSchema, OptedCompany, OptedInventory, OptType, OptedStore, OptOutInventory, TokenResponseSchema, Tokens, Firebase, Credentials, Ios, Android, Moengage, MoengageCredentials, Segment, SegmentCredentials, Gtm, GtmCredentials, Freshchat, FreshchatCredentials, Safetynet, SafetynetCredentials, FyndRewards, FyndRewardsCredentials, GoogleMap, GoogleMapCredentials, RewardPointsConfig, Credit, Debit, ProductDetailFeature, LaunchPage, LandingPageFeature, ListingPageFeature, RegistrationPageFeature, BuyboxFeature, DeliveryStrategy, FulfillmentOption, AppFeature, HomePageFeature, CommonFeature, InternationalShipping, CommunicationOptinDialogFeature, DeploymentStoreSelectionFeature, ListingPriceFeature, CurrencyFeature, RevenueEngineFeature, FeedbackFeature, CompareProductsFeature, CartFeature, QrFeature, PcrFeature, OrderFeature, AppFeatureRequestSchema, AppFeatureResponseSchema, Currency, ApplicationWebsite, ApplicationCors, ApplicationAuth, ApplicationRedirections, ApplicationMeta, SecureUrl, Application, ApplicationById, TokenSchemaID, TokenSchema, InvalidPayloadRequestSchema, Page, ApplicationInformation, InformationAddress, InformationPhone, InformationLoc, InformationSupport, InformationSupportPhone, InformationSupportEmail, SocialLinks, FacebookLink, InstagramLink, TwitterLink, PinterestLink, GooglePlusLink, YoutubeLink, LinkedInLink, VimeoLink, BlogLink, Links, BusinessHighlights, ApplicationDetail, CurrenciesResponseSchema, AppCurrencyResponseSchema, StoreLatLong, OptedStoreAddress, OrderingStore, OrderingStores, OrderingStoresResponseSchema, ValidationErrors, ValidationError };
|
|
1418
|
+
export { CurrencyExchangeResponseV2, CurrencyExchangeItem, ApplicationInventory, PiiMasking, FstIdentification, SkgIdentification, QuerySuggestions, SearchConfig, AppInventoryConfig, InventoryBrand, InventoryStore, AppStoreRules, InventoryCategory, InventoryPrice, InventoryDiscount, AuthenticationConfig, ArticleAssignmentConfig, ArticleAssignmentRules, StorePriority, AppCartConfig, InternationalDeliveryCharges, DeliveryCharges, Charges, AppPaymentConfig, CallbackUrl, Methods, PaymentModeConfig, PaymentSelectionLock, AppOrderConfig, ProcessingSchedule, StartAfter, AppLogisticsConfig, LoyaltyPointsConfig, AppInventoryPartialUpdate, BrandCompanyInfo, CompanyByBrandsRequestSchema, CompanyByBrandsResponseSchema, StoreByBrandsRequestSchema, StoreByBrandsResponseSchema, BrandStoreInfo, CompanyBrandInfo, BrandsByCompanyResponseSchema, ValidationFailedResponseSchema, NotFound, CommunicationConfig, CommsConfig, PanCardConfig, CreateApplicationRequestSchema, CreateAppResponseSchema, ApplicationsResponseSchema, MobileAppConfiguration, LandingImage, SplashImage, MobileAppConfigRequestSchema, BuildVersionHistory, BuildVersion, AppSupportedCurrency, DefaultCurrency, DomainAdd, DomainAddRequestSchema, Domain, DomainsResponseSchema, UpdateDomain, UpdateDomainTypeRequestSchema, DomainStatusRequestSchema, DomainStatus, DomainStatusResponseSchema, DomainSuggestionsRequestSchema, DomainSuggestion, DomainSuggestionsResponseSchema, SuccessMessageResponseSchema, App, AppDomain, CompaniesResponseSchema, AppInventoryCompanies, StoresResponseSchema, AppInventoryStores, FilterOrderingStoreRequestSchema, DeploymentMeta, OrderingStoreConfig, OrderingStoreSelectRequestSchema, OrderingStoreSelect, OtherSellerCompany, OtherSellerApplication, OtherSellerApplications, OptedApplicationResponseSchema, OptedCompany, OptedInventory, OptType, OptedStore, OptOutInventory, TokenResponseSchema, Tokens, Firebase, Credentials, Ios, Android, Moengage, MoengageCredentials, Segment, SegmentCredentials, Gtm, GtmCredentials, Freshchat, FreshchatCredentials, Safetynet, SafetynetCredentials, FyndRewards, FyndRewardsCredentials, GoogleMap, GoogleMapCredentials, RewardPointsConfig, Credit, Debit, ProductDetailFeature, LaunchPage, LandingPageFeature, ListingPageFeature, RegistrationPageFeature, BuyboxFeature, DeliveryStrategy, FulfillmentOption, AppFeature, HomePageFeature, CommonFeature, InternationalShipping, CommunicationOptinDialogFeature, DeploymentStoreSelectionFeature, ListingPriceFeature, CurrencyFeature, RevenueEngineFeature, FeedbackFeature, CompareProductsFeature, CartFeature, QrFeature, PcrFeature, OrderFeature, AppFeatureRequestSchema, AppFeatureResponseSchema, Currency, ApplicationWebsite, ApplicationCors, ApplicationAuth, ApplicationRedirections, ApplicationMeta, SecureUrl, Application, ApplicationById, TokenSchemaID, TokenSchema, InvalidPayloadRequestSchema, Page, ApplicationInformation, InformationAddress, InformationPhone, InformationLoc, InformationSupport, InformationSupportPhone, InformationSupportEmail, SocialLinks, FacebookLink, InstagramLink, TwitterLink, PinterestLink, GooglePlusLink, YoutubeLink, LinkedInLink, VimeoLink, BlogLink, Links, BusinessHighlights, ApplicationDetail, CurrenciesResponseSchema, AppCurrencyResponseSchema, StoreLatLong, OptedStoreAddress, OrderingStore, OrderingStores, OrderingStoresResponseSchema, ValidationErrors, ValidationError };
|
|
1413
1419
|
}
|
|
1414
1420
|
/** @returns {CurrencyExchangeResponseV2} */
|
|
1415
1421
|
declare function CurrencyExchangeResponseV2(): CurrencyExchangeResponseV2;
|
|
@@ -1539,6 +1545,15 @@ type FstIdentification = {
|
|
|
1539
1545
|
*/
|
|
1540
1546
|
enabled?: boolean;
|
|
1541
1547
|
};
|
|
1548
|
+
/** @returns {SkgIdentification} */
|
|
1549
|
+
declare function SkgIdentification(): SkgIdentification;
|
|
1550
|
+
type SkgIdentification = {
|
|
1551
|
+
/**
|
|
1552
|
+
* - Indicates whether semantic knowledge
|
|
1553
|
+
* graph-based search is enabled for the application.
|
|
1554
|
+
*/
|
|
1555
|
+
enabled?: boolean;
|
|
1556
|
+
};
|
|
1542
1557
|
/** @returns {QuerySuggestions} */
|
|
1543
1558
|
declare function QuerySuggestions(): QuerySuggestions;
|
|
1544
1559
|
type QuerySuggestions = {
|
|
@@ -1559,6 +1574,7 @@ declare function SearchConfig(): SearchConfig;
|
|
|
1559
1574
|
type SearchConfig = {
|
|
1560
1575
|
fst_identification?: FstIdentification;
|
|
1561
1576
|
query_suggestions?: QuerySuggestions;
|
|
1577
|
+
skg_identification?: SkgIdentification;
|
|
1562
1578
|
};
|
|
1563
1579
|
/** @returns {AppInventoryConfig} */
|
|
1564
1580
|
declare function AppInventoryConfig(): AppInventoryConfig;
|
|
@@ -65,6 +65,12 @@ const Joi = require("joi");
|
|
|
65
65
|
* is enabled for the application.
|
|
66
66
|
*/
|
|
67
67
|
|
|
68
|
+
/**
|
|
69
|
+
* @typedef SkgIdentification
|
|
70
|
+
* @property {boolean} [enabled] - Indicates whether semantic knowledge
|
|
71
|
+
* graph-based search is enabled for the application.
|
|
72
|
+
*/
|
|
73
|
+
|
|
68
74
|
/**
|
|
69
75
|
* @typedef QuerySuggestions
|
|
70
76
|
* @property {boolean} [enabled] - Indicates whether to enable or disable query
|
|
@@ -78,6 +84,7 @@ const Joi = require("joi");
|
|
|
78
84
|
* @typedef SearchConfig
|
|
79
85
|
* @property {FstIdentification} [fst_identification]
|
|
80
86
|
* @property {QuerySuggestions} [query_suggestions]
|
|
87
|
+
* @property {SkgIdentification} [skg_identification]
|
|
81
88
|
*/
|
|
82
89
|
|
|
83
90
|
/**
|
|
@@ -1657,6 +1664,13 @@ class ConfigurationPlatformModel {
|
|
|
1657
1664
|
});
|
|
1658
1665
|
}
|
|
1659
1666
|
|
|
1667
|
+
/** @returns {SkgIdentification} */
|
|
1668
|
+
static SkgIdentification() {
|
|
1669
|
+
return Joi.object({
|
|
1670
|
+
enabled: Joi.boolean(),
|
|
1671
|
+
});
|
|
1672
|
+
}
|
|
1673
|
+
|
|
1660
1674
|
/** @returns {QuerySuggestions} */
|
|
1661
1675
|
static QuerySuggestions() {
|
|
1662
1676
|
return Joi.object({
|
|
@@ -1670,6 +1684,7 @@ class ConfigurationPlatformModel {
|
|
|
1670
1684
|
return Joi.object({
|
|
1671
1685
|
fst_identification: ConfigurationPlatformModel.FstIdentification(),
|
|
1672
1686
|
query_suggestions: ConfigurationPlatformModel.QuerySuggestions(),
|
|
1687
|
+
skg_identification: ConfigurationPlatformModel.SkgIdentification(),
|
|
1673
1688
|
});
|
|
1674
1689
|
}
|
|
1675
1690
|
|
|
@@ -297,6 +297,19 @@ declare class Serviceability {
|
|
|
297
297
|
* @description: Fetches available fulfillment options for a given product and store. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getFulfillmentOptions/).
|
|
298
298
|
*/
|
|
299
299
|
getFulfillmentOptions({ slug, productId, storeId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetFulfillmentOptionsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.FulfillmentOption>;
|
|
300
|
+
/**
|
|
301
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetFulfillmentOptionsListParam} arg
|
|
302
|
+
* - Arg object
|
|
303
|
+
*
|
|
304
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
305
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
306
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOptionsList>} -
|
|
307
|
+
* Success response
|
|
308
|
+
* @name getFulfillmentOptionsList
|
|
309
|
+
* @summary: Retrieve fulfillment options with optional filters.
|
|
310
|
+
* @description: Fetches fulfillment options for an application. Queryable by product_slug, store_id, and status. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getFulfillmentOptionsList/).
|
|
311
|
+
*/
|
|
312
|
+
getFulfillmentOptionsList({ productSlug, storeId, status, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetFulfillmentOptionsListParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.FulfillmentOptionsList>;
|
|
300
313
|
/**
|
|
301
314
|
* @param {ServiceabilityPlatformApplicationValidator.GetGeoAreaParam} arg
|
|
302
315
|
* - Arg object
|
|
@@ -1834,6 +1834,95 @@ class Serviceability {
|
|
|
1834
1834
|
return response;
|
|
1835
1835
|
}
|
|
1836
1836
|
|
|
1837
|
+
/**
|
|
1838
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetFulfillmentOptionsListParam} arg
|
|
1839
|
+
* - Arg object
|
|
1840
|
+
*
|
|
1841
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1842
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
1843
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOptionsList>} -
|
|
1844
|
+
* Success response
|
|
1845
|
+
* @name getFulfillmentOptionsList
|
|
1846
|
+
* @summary: Retrieve fulfillment options with optional filters.
|
|
1847
|
+
* @description: Fetches fulfillment options for an application. Queryable by product_slug, store_id, and status. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getFulfillmentOptionsList/).
|
|
1848
|
+
*/
|
|
1849
|
+
async getFulfillmentOptionsList(
|
|
1850
|
+
{ productSlug, storeId, status, requestHeaders } = { requestHeaders: {} },
|
|
1851
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
1852
|
+
) {
|
|
1853
|
+
const {
|
|
1854
|
+
error,
|
|
1855
|
+
} = ServiceabilityPlatformApplicationValidator.getFulfillmentOptionsList().validate(
|
|
1856
|
+
{
|
|
1857
|
+
productSlug,
|
|
1858
|
+
storeId,
|
|
1859
|
+
status,
|
|
1860
|
+
},
|
|
1861
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1862
|
+
);
|
|
1863
|
+
if (error) {
|
|
1864
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
1865
|
+
}
|
|
1866
|
+
|
|
1867
|
+
// Showing warrnings if extra unknown parameters are found
|
|
1868
|
+
const {
|
|
1869
|
+
error: warrning,
|
|
1870
|
+
} = ServiceabilityPlatformApplicationValidator.getFulfillmentOptionsList().validate(
|
|
1871
|
+
{
|
|
1872
|
+
productSlug,
|
|
1873
|
+
storeId,
|
|
1874
|
+
status,
|
|
1875
|
+
},
|
|
1876
|
+
{ abortEarly: false, allowUnknown: false }
|
|
1877
|
+
);
|
|
1878
|
+
if (warrning) {
|
|
1879
|
+
Logger({
|
|
1880
|
+
level: "WARN",
|
|
1881
|
+
message: `Parameter Validation warrnings for platform > Serviceability > getFulfillmentOptionsList \n ${warrning}`,
|
|
1882
|
+
});
|
|
1883
|
+
}
|
|
1884
|
+
|
|
1885
|
+
const query_params = {};
|
|
1886
|
+
query_params["product_slug"] = productSlug;
|
|
1887
|
+
query_params["store_id"] = storeId;
|
|
1888
|
+
query_params["status"] = status;
|
|
1889
|
+
|
|
1890
|
+
const response = await PlatformAPIClient.execute(
|
|
1891
|
+
this.config,
|
|
1892
|
+
"get",
|
|
1893
|
+
`/service/platform/logistics/v1.0/company/${this.config.companyId}/application/${this.applicationId}/fulfillment-options`,
|
|
1894
|
+
query_params,
|
|
1895
|
+
undefined,
|
|
1896
|
+
requestHeaders,
|
|
1897
|
+
{ responseHeaders }
|
|
1898
|
+
);
|
|
1899
|
+
|
|
1900
|
+
let responseData = response;
|
|
1901
|
+
if (responseHeaders) {
|
|
1902
|
+
responseData = response[0];
|
|
1903
|
+
}
|
|
1904
|
+
|
|
1905
|
+
const {
|
|
1906
|
+
error: res_error,
|
|
1907
|
+
} = ServiceabilityPlatformModel.FulfillmentOptionsList().validate(
|
|
1908
|
+
responseData,
|
|
1909
|
+
{ abortEarly: false, allowUnknown: true }
|
|
1910
|
+
);
|
|
1911
|
+
|
|
1912
|
+
if (res_error) {
|
|
1913
|
+
if (this.config.options.strictResponseCheck === true) {
|
|
1914
|
+
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
1915
|
+
} else {
|
|
1916
|
+
Logger({
|
|
1917
|
+
level: "WARN",
|
|
1918
|
+
message: `Response Validation Warnings for platform > Serviceability > getFulfillmentOptionsList \n ${res_error}`,
|
|
1919
|
+
});
|
|
1920
|
+
}
|
|
1921
|
+
}
|
|
1922
|
+
|
|
1923
|
+
return response;
|
|
1924
|
+
}
|
|
1925
|
+
|
|
1837
1926
|
/**
|
|
1838
1927
|
* @param {ServiceabilityPlatformApplicationValidator.GetGeoAreaParam} arg
|
|
1839
1928
|
* - Arg object
|
|
@@ -85,6 +85,13 @@ export = ServiceabilityPlatformApplicationValidator;
|
|
|
85
85
|
* @property {number} [productId] - The unique identifier of the product.
|
|
86
86
|
* @property {number} [storeId] - The unique identifier of the store.
|
|
87
87
|
*/
|
|
88
|
+
/**
|
|
89
|
+
* @typedef GetFulfillmentOptionsListParam
|
|
90
|
+
* @property {string} [productSlug] - The unique identifier (slug) of the product.
|
|
91
|
+
* @property {number} [storeId] - The unique identifier of the store.
|
|
92
|
+
* @property {string} [status] - Status of the fulfillment option. Must be
|
|
93
|
+
* either `ACTIVE` or `INACTIVE`.
|
|
94
|
+
*/
|
|
88
95
|
/**
|
|
89
96
|
* @typedef GetGeoAreaParam
|
|
90
97
|
* @property {string} geoareaId - A unique identifier for the GeoArea.
|
|
@@ -267,6 +274,8 @@ declare class ServiceabilityPlatformApplicationValidator {
|
|
|
267
274
|
static getFulfillmentOptionStores(): GetFulfillmentOptionStoresParam;
|
|
268
275
|
/** @returns {GetFulfillmentOptionsParam} */
|
|
269
276
|
static getFulfillmentOptions(): GetFulfillmentOptionsParam;
|
|
277
|
+
/** @returns {GetFulfillmentOptionsListParam} */
|
|
278
|
+
static getFulfillmentOptionsList(): GetFulfillmentOptionsListParam;
|
|
270
279
|
/** @returns {GetGeoAreaParam} */
|
|
271
280
|
static getGeoArea(): GetGeoAreaParam;
|
|
272
281
|
/** @returns {GetGeoAreaExportJobStatusParam} */
|
|
@@ -319,7 +328,7 @@ declare class ServiceabilityPlatformApplicationValidator {
|
|
|
319
328
|
static validateBulkFulfillmentOptions(): ValidateBulkFulfillmentOptionsParam;
|
|
320
329
|
}
|
|
321
330
|
declare namespace ServiceabilityPlatformApplicationValidator {
|
|
322
|
-
export { CreateBulkExportParam, CreateBulkGeoAreaParam, CreateCourierPartnerRuleParam, CreateFulfillmentOptionParam, CreateGeoAreaParam, CreateGeoAreaExportJobParam, CreateStoreRulesParam, CreateZoneParam, DeleteFulfillmentOptionsParam, DeleteZoneParam, DownloadGeoareaSampleFileParam, GetApplicationConfigParam, GetApplicationConfigurationParam, GetBulkExportParam, GetBulkFulfillmentValidationStatusParam, GetBulkGeoAreaParam, GetCourierPartnerRuleParam, GetCourierPartnerRulesParam, GetCourierPartnersParam, GetFulfillmentOptionProductsParam, GetFulfillmentOptionStoresParam, GetFulfillmentOptionsParam, GetGeoAreaParam, GetGeoAreaExportJobStatusParam, GetGeoAreasParam, GetStoreRuleParam, GetStoreRulesParam, GetZoneParam, GetZonesParam, InsertApplicationConfigParam, PatchApplicationConfigurationParam, PutFulfillmentOptionParam, UpdateApplicationConfigurationParam, UpdateBulkGeoAreaParam, UpdateCourierPartnerRulePriorityParam, UpdateCourierRuleParam, UpdateGeoAreaParam, UpdatePincodeAuditHistoryParam, UpdatePincodeBulkViewParam, UpdatePincodeCoDListingParam, UpdatePincodeMopViewParam, UpdateStoreRulePriorityParam, UpdateStoreRulesParam, UpdateStoreRulesConfigParam, UpdateZoneParam, UploadBulkFulfillmentOptionsParam, ValidateBulkFulfillmentOptionsParam };
|
|
331
|
+
export { CreateBulkExportParam, CreateBulkGeoAreaParam, CreateCourierPartnerRuleParam, CreateFulfillmentOptionParam, CreateGeoAreaParam, CreateGeoAreaExportJobParam, CreateStoreRulesParam, CreateZoneParam, DeleteFulfillmentOptionsParam, DeleteZoneParam, DownloadGeoareaSampleFileParam, GetApplicationConfigParam, GetApplicationConfigurationParam, GetBulkExportParam, GetBulkFulfillmentValidationStatusParam, GetBulkGeoAreaParam, GetCourierPartnerRuleParam, GetCourierPartnerRulesParam, GetCourierPartnersParam, GetFulfillmentOptionProductsParam, GetFulfillmentOptionStoresParam, GetFulfillmentOptionsParam, GetFulfillmentOptionsListParam, GetGeoAreaParam, GetGeoAreaExportJobStatusParam, GetGeoAreasParam, GetStoreRuleParam, GetStoreRulesParam, GetZoneParam, GetZonesParam, InsertApplicationConfigParam, PatchApplicationConfigurationParam, PutFulfillmentOptionParam, UpdateApplicationConfigurationParam, UpdateBulkGeoAreaParam, UpdateCourierPartnerRulePriorityParam, UpdateCourierRuleParam, UpdateGeoAreaParam, UpdatePincodeAuditHistoryParam, UpdatePincodeBulkViewParam, UpdatePincodeCoDListingParam, UpdatePincodeMopViewParam, UpdateStoreRulePriorityParam, UpdateStoreRulesParam, UpdateStoreRulesConfigParam, UpdateZoneParam, UploadBulkFulfillmentOptionsParam, ValidateBulkFulfillmentOptionsParam };
|
|
323
332
|
}
|
|
324
333
|
type CreateBulkExportParam = {
|
|
325
334
|
body: ServiceabilityPlatformModel.BulkCreateZoneExport;
|
|
@@ -439,6 +448,21 @@ type GetFulfillmentOptionsParam = {
|
|
|
439
448
|
*/
|
|
440
449
|
storeId?: number;
|
|
441
450
|
};
|
|
451
|
+
type GetFulfillmentOptionsListParam = {
|
|
452
|
+
/**
|
|
453
|
+
* - The unique identifier (slug) of the product.
|
|
454
|
+
*/
|
|
455
|
+
productSlug?: string;
|
|
456
|
+
/**
|
|
457
|
+
* - The unique identifier of the store.
|
|
458
|
+
*/
|
|
459
|
+
storeId?: number;
|
|
460
|
+
/**
|
|
461
|
+
* - Status of the fulfillment option. Must be
|
|
462
|
+
* either `ACTIVE` or `INACTIVE`.
|
|
463
|
+
*/
|
|
464
|
+
status?: string;
|
|
465
|
+
};
|
|
442
466
|
type GetGeoAreaParam = {
|
|
443
467
|
/**
|
|
444
468
|
* - A unique identifier for the GeoArea.
|
|
@@ -110,6 +110,14 @@ const ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|
|
|
110
110
|
* @property {number} [storeId] - The unique identifier of the store.
|
|
111
111
|
*/
|
|
112
112
|
|
|
113
|
+
/**
|
|
114
|
+
* @typedef GetFulfillmentOptionsListParam
|
|
115
|
+
* @property {string} [productSlug] - The unique identifier (slug) of the product.
|
|
116
|
+
* @property {number} [storeId] - The unique identifier of the store.
|
|
117
|
+
* @property {string} [status] - Status of the fulfillment option. Must be
|
|
118
|
+
* either `ACTIVE` or `INACTIVE`.
|
|
119
|
+
*/
|
|
120
|
+
|
|
113
121
|
/**
|
|
114
122
|
* @typedef GetGeoAreaParam
|
|
115
123
|
* @property {string} geoareaId - A unique identifier for the GeoArea.
|
|
@@ -428,6 +436,15 @@ class ServiceabilityPlatformApplicationValidator {
|
|
|
428
436
|
}).required();
|
|
429
437
|
}
|
|
430
438
|
|
|
439
|
+
/** @returns {GetFulfillmentOptionsListParam} */
|
|
440
|
+
static getFulfillmentOptionsList() {
|
|
441
|
+
return Joi.object({
|
|
442
|
+
productSlug: Joi.string().allow(""),
|
|
443
|
+
storeId: Joi.number(),
|
|
444
|
+
status: Joi.string().allow(""),
|
|
445
|
+
}).required();
|
|
446
|
+
}
|
|
447
|
+
|
|
431
448
|
/** @returns {GetGeoAreaParam} */
|
|
432
449
|
static getGeoArea() {
|
|
433
450
|
return Joi.object({
|
|
@@ -15,6 +15,10 @@ export = ServiceabilityPlatformModel;
|
|
|
15
15
|
* @property {CourierPartnerSchemes} [cp_schemes]
|
|
16
16
|
* @property {string} [id] - Unique identifier for the fulfillment option.
|
|
17
17
|
*/
|
|
18
|
+
/**
|
|
19
|
+
* @typedef FulfillmentOptionsList
|
|
20
|
+
* @property {FulfillmentOptionItem[]} [items] - List of fulfillment option items.
|
|
21
|
+
*/
|
|
18
22
|
/**
|
|
19
23
|
* @typedef FulfillmentOptionProducts
|
|
20
24
|
* @property {FulfillmentOptionProduct} [items]
|
|
@@ -1192,6 +1196,15 @@ export = ServiceabilityPlatformModel;
|
|
|
1192
1196
|
* @property {string} [scheme_id] - Unique identifier for the courier partner scheme.
|
|
1193
1197
|
* @property {string} [cp_ext_id] - Unique identifier for the courier partner.
|
|
1194
1198
|
*/
|
|
1199
|
+
/**
|
|
1200
|
+
* @typedef FulfillmentOptionItem
|
|
1201
|
+
* @property {string} [slug] - Unique identifier for the delivery type.
|
|
1202
|
+
* @property {string} [description] - Description of the delivery service.
|
|
1203
|
+
* @property {boolean} [is_default] - Indicates if this is the default delivery option.
|
|
1204
|
+
* @property {string} [id] - Unique ID of the delivery service.
|
|
1205
|
+
* @property {string} [type] - Type of fulfillment option.
|
|
1206
|
+
* @property {string} [name] - Name of the delivery service.
|
|
1207
|
+
*/
|
|
1195
1208
|
/**
|
|
1196
1209
|
* @typedef FulfillmentOptionProduct
|
|
1197
1210
|
* @property {number} [uid] - Unique identifier for the product.
|
|
@@ -2281,7 +2294,7 @@ export = ServiceabilityPlatformModel;
|
|
|
2281
2294
|
declare class ServiceabilityPlatformModel {
|
|
2282
2295
|
}
|
|
2283
2296
|
declare namespace ServiceabilityPlatformModel {
|
|
2284
|
-
export { FulfillmentOption, 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, 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, ShipmentDimension, ShipmentsArticles, ArticleWeight, ArticleAttributes, ArticleDimension, ArticleSet, ArticleSizeDistribution, SetSize, ArticleDeliverySlots, ArticleReturnReason, CourierPartners, CourierPartnerPromise, CourierPartnerAttributes, CourierPartnerTAT, ShipmentCourierPartners, CourierPartnerConfig, BuyboxRuleConfig, PromiseConfig, StorePromiseAttributeConfig, DeliveryServiceAttributeConfig, BufferField, StorePrioritySchema, StoreRuleConditionSchema, CustomerRadiusSchema, DateOperations, 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 };
|
|
2297
|
+
export { 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, BusinessUnit, FulfillmentStores, FulfillmentProducts, CourierPartnerSchemes, CourierPartnerScheme, FulfillmentOptionItem, 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, ShipmentDimension, ShipmentsArticles, ArticleWeight, ArticleAttributes, ArticleDimension, ArticleSet, ArticleSizeDistribution, SetSize, ArticleDeliverySlots, ArticleReturnReason, CourierPartners, CourierPartnerPromise, CourierPartnerAttributes, CourierPartnerTAT, ShipmentCourierPartners, CourierPartnerConfig, BuyboxRuleConfig, PromiseConfig, StorePromiseAttributeConfig, DeliveryServiceAttributeConfig, BufferField, StorePrioritySchema, StoreRuleConditionSchema, CustomerRadiusSchema, DateOperations, 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 };
|
|
2285
2298
|
}
|
|
2286
2299
|
/** @returns {FulfillmentOption} */
|
|
2287
2300
|
declare function FulfillmentOption(): FulfillmentOption;
|
|
@@ -2327,6 +2340,14 @@ type FulfillmentOption = {
|
|
|
2327
2340
|
*/
|
|
2328
2341
|
id?: string;
|
|
2329
2342
|
};
|
|
2343
|
+
/** @returns {FulfillmentOptionsList} */
|
|
2344
|
+
declare function FulfillmentOptionsList(): FulfillmentOptionsList;
|
|
2345
|
+
type FulfillmentOptionsList = {
|
|
2346
|
+
/**
|
|
2347
|
+
* - List of fulfillment option items.
|
|
2348
|
+
*/
|
|
2349
|
+
items?: FulfillmentOptionItem[];
|
|
2350
|
+
};
|
|
2330
2351
|
/** @returns {FulfillmentOptionProducts} */
|
|
2331
2352
|
declare function FulfillmentOptionProducts(): FulfillmentOptionProducts;
|
|
2332
2353
|
type FulfillmentOptionProducts = {
|
|
@@ -5230,6 +5251,34 @@ type CourierPartnerScheme = {
|
|
|
5230
5251
|
*/
|
|
5231
5252
|
cp_ext_id?: string;
|
|
5232
5253
|
};
|
|
5254
|
+
/** @returns {FulfillmentOptionItem} */
|
|
5255
|
+
declare function FulfillmentOptionItem(): FulfillmentOptionItem;
|
|
5256
|
+
type FulfillmentOptionItem = {
|
|
5257
|
+
/**
|
|
5258
|
+
* - Unique identifier for the delivery type.
|
|
5259
|
+
*/
|
|
5260
|
+
slug?: string;
|
|
5261
|
+
/**
|
|
5262
|
+
* - Description of the delivery service.
|
|
5263
|
+
*/
|
|
5264
|
+
description?: string;
|
|
5265
|
+
/**
|
|
5266
|
+
* - Indicates if this is the default delivery option.
|
|
5267
|
+
*/
|
|
5268
|
+
is_default?: boolean;
|
|
5269
|
+
/**
|
|
5270
|
+
* - Unique ID of the delivery service.
|
|
5271
|
+
*/
|
|
5272
|
+
id?: string;
|
|
5273
|
+
/**
|
|
5274
|
+
* - Type of fulfillment option.
|
|
5275
|
+
*/
|
|
5276
|
+
type?: string;
|
|
5277
|
+
/**
|
|
5278
|
+
* - Name of the delivery service.
|
|
5279
|
+
*/
|
|
5280
|
+
name?: string;
|
|
5281
|
+
};
|
|
5233
5282
|
/** @returns {FulfillmentOptionProduct} */
|
|
5234
5283
|
declare function FulfillmentOptionProduct(): FulfillmentOptionProduct;
|
|
5235
5284
|
type FulfillmentOptionProduct = {
|
|
@@ -17,6 +17,11 @@ const Joi = require("joi");
|
|
|
17
17
|
* @property {string} [id] - Unique identifier for the fulfillment option.
|
|
18
18
|
*/
|
|
19
19
|
|
|
20
|
+
/**
|
|
21
|
+
* @typedef FulfillmentOptionsList
|
|
22
|
+
* @property {FulfillmentOptionItem[]} [items] - List of fulfillment option items.
|
|
23
|
+
*/
|
|
24
|
+
|
|
20
25
|
/**
|
|
21
26
|
* @typedef FulfillmentOptionProducts
|
|
22
27
|
* @property {FulfillmentOptionProduct} [items]
|
|
@@ -1306,6 +1311,16 @@ const Joi = require("joi");
|
|
|
1306
1311
|
* @property {string} [cp_ext_id] - Unique identifier for the courier partner.
|
|
1307
1312
|
*/
|
|
1308
1313
|
|
|
1314
|
+
/**
|
|
1315
|
+
* @typedef FulfillmentOptionItem
|
|
1316
|
+
* @property {string} [slug] - Unique identifier for the delivery type.
|
|
1317
|
+
* @property {string} [description] - Description of the delivery service.
|
|
1318
|
+
* @property {boolean} [is_default] - Indicates if this is the default delivery option.
|
|
1319
|
+
* @property {string} [id] - Unique ID of the delivery service.
|
|
1320
|
+
* @property {string} [type] - Type of fulfillment option.
|
|
1321
|
+
* @property {string} [name] - Name of the delivery service.
|
|
1322
|
+
*/
|
|
1323
|
+
|
|
1309
1324
|
/**
|
|
1310
1325
|
* @typedef FulfillmentOptionProduct
|
|
1311
1326
|
* @property {number} [uid] - Unique identifier for the product.
|
|
@@ -2535,6 +2550,15 @@ class ServiceabilityPlatformModel {
|
|
|
2535
2550
|
});
|
|
2536
2551
|
}
|
|
2537
2552
|
|
|
2553
|
+
/** @returns {FulfillmentOptionsList} */
|
|
2554
|
+
static FulfillmentOptionsList() {
|
|
2555
|
+
return Joi.object({
|
|
2556
|
+
items: Joi.array().items(
|
|
2557
|
+
ServiceabilityPlatformModel.FulfillmentOptionItem()
|
|
2558
|
+
),
|
|
2559
|
+
});
|
|
2560
|
+
}
|
|
2561
|
+
|
|
2538
2562
|
/** @returns {FulfillmentOptionProducts} */
|
|
2539
2563
|
static FulfillmentOptionProducts() {
|
|
2540
2564
|
return Joi.object({
|
|
@@ -3910,6 +3934,18 @@ class ServiceabilityPlatformModel {
|
|
|
3910
3934
|
});
|
|
3911
3935
|
}
|
|
3912
3936
|
|
|
3937
|
+
/** @returns {FulfillmentOptionItem} */
|
|
3938
|
+
static FulfillmentOptionItem() {
|
|
3939
|
+
return Joi.object({
|
|
3940
|
+
slug: Joi.string().allow(""),
|
|
3941
|
+
description: Joi.string().allow(""),
|
|
3942
|
+
is_default: Joi.boolean(),
|
|
3943
|
+
id: Joi.string().allow(""),
|
|
3944
|
+
type: Joi.string().allow(""),
|
|
3945
|
+
name: Joi.string().allow(""),
|
|
3946
|
+
});
|
|
3947
|
+
}
|
|
3948
|
+
|
|
3913
3949
|
/** @returns {FulfillmentOptionProduct} */
|
|
3914
3950
|
static FulfillmentOptionProduct() {
|
|
3915
3951
|
return Joi.object({
|