@gofynd/fdk-client-javascript 3.4.4 → 3.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationAPIClient.d.ts +1 -1
- package/sdk/application/ApplicationClient.d.ts +1 -1
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +50 -0
- package/sdk/application/Payment/PaymentApplicationClient.js +210 -0
- package/sdk/partner/OAuthClient.d.ts +3 -3
- package/sdk/partner/PartnerAPIClient.d.ts +1 -1
- package/sdk/partner/PartnerClient.d.ts +2 -2
- package/sdk/platform/Cart/CartPlatformModel.d.ts +11 -0
- package/sdk/platform/Cart/CartPlatformModel.js +5 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +1 -4
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +0 -5
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +0 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +125 -1
- package/sdk/platform/Catalog/CatalogPlatformClient.js +1075 -95
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +1017 -46
- package/sdk/platform/Catalog/CatalogPlatformModel.js +681 -5
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +200 -5
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +174 -4
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +17 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +15 -0
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +9 -4
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +4 -4
- package/sdk/platform/OAuthClient.d.ts +3 -3
- package/sdk/platform/Order/OrderPlatformModel.d.ts +49 -1
- package/sdk/platform/Order/OrderPlatformModel.js +28 -0
- package/sdk/platform/PlatformAPIClient.d.ts +1 -1
- package/sdk/platform/PlatformClient.d.ts +2 -2
- 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 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +36 -4
- package/sdk/public/PublicAPIClient.d.ts +1 -1
|
@@ -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
|
|
|
@@ -58,8 +58,9 @@ export = FileStoragePlatformModel;
|
|
|
58
58
|
*/
|
|
59
59
|
/**
|
|
60
60
|
* @typedef ProxyFileAccess
|
|
61
|
-
* @property {
|
|
62
|
-
*
|
|
61
|
+
* @property {boolean} [success] - A boolean value indicating whether the proxy
|
|
62
|
+
* request was successful. Returns true when the external URL was successfully
|
|
63
|
+
* fetched and processed.
|
|
63
64
|
*/
|
|
64
65
|
/**
|
|
65
66
|
* @typedef DestinationNamespace
|
|
@@ -271,8 +272,12 @@ type FileUploadComplete = {
|
|
|
271
272
|
/** @returns {ProxyFileAccess} */
|
|
272
273
|
declare function ProxyFileAccess(): ProxyFileAccess;
|
|
273
274
|
type ProxyFileAccess = {
|
|
274
|
-
|
|
275
|
-
|
|
275
|
+
/**
|
|
276
|
+
* - A boolean value indicating whether the proxy
|
|
277
|
+
* request was successful. Returns true when the external URL was successfully
|
|
278
|
+
* fetched and processed.
|
|
279
|
+
*/
|
|
280
|
+
success?: boolean;
|
|
276
281
|
};
|
|
277
282
|
/** @returns {DestinationNamespace} */
|
|
278
283
|
declare function DestinationNamespace(): DestinationNamespace;
|
|
@@ -66,8 +66,9 @@ const Joi = require("joi");
|
|
|
66
66
|
|
|
67
67
|
/**
|
|
68
68
|
* @typedef ProxyFileAccess
|
|
69
|
-
* @property {
|
|
70
|
-
*
|
|
69
|
+
* @property {boolean} [success] - A boolean value indicating whether the proxy
|
|
70
|
+
* request was successful. Returns true when the external URL was successfully
|
|
71
|
+
* fetched and processed.
|
|
71
72
|
*/
|
|
72
73
|
|
|
73
74
|
/**
|
|
@@ -310,8 +311,7 @@ class FileStoragePlatformModel {
|
|
|
310
311
|
/** @returns {ProxyFileAccess} */
|
|
311
312
|
static ProxyFileAccess() {
|
|
312
313
|
return Joi.object({
|
|
313
|
-
|
|
314
|
-
support: Joi.object().pattern(/\S/, Joi.any()),
|
|
314
|
+
success: Joi.boolean(),
|
|
315
315
|
});
|
|
316
316
|
}
|
|
317
317
|
|
|
@@ -20,7 +20,7 @@ declare class OAuthClient {
|
|
|
20
20
|
grant_type: any;
|
|
21
21
|
refresh_token: any;
|
|
22
22
|
code: any;
|
|
23
|
-
}): Promise<import("axios").AxiosResponse<any, any>>;
|
|
24
|
-
getOfflineAccessToken(scopes: any, code: any): Promise<import("axios").AxiosResponse<any, any>>;
|
|
25
|
-
getOfflineAccessTokenObj(scopes: any, code: any): Promise<import("axios").AxiosResponse<any, any>>;
|
|
23
|
+
}): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
24
|
+
getOfflineAccessToken(scopes: any, code: any): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
25
|
+
getOfflineAccessTokenObj(scopes: any, code: any): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
26
26
|
}
|
|
@@ -2917,6 +2917,21 @@ export = OrderPlatformModel;
|
|
|
2917
2917
|
* a unique identifier for books, allowing for easier management and tracking
|
|
2918
2918
|
* of book inventories in retail and library systems.
|
|
2919
2919
|
*/
|
|
2920
|
+
/**
|
|
2921
|
+
* @typedef TaxComponent
|
|
2922
|
+
* @property {string} [name] - The name or type of the tax component (e.g., GST,
|
|
2923
|
+
* VAT, Service Tax). This helps in identifying the specific tax being applied
|
|
2924
|
+
* to the transaction or item.
|
|
2925
|
+
* @property {number} [rate] - The percentage rate at which the tax is applied
|
|
2926
|
+
* to the taxable amount. This value is typically represented as a decimal
|
|
2927
|
+
* (e.g., 0.18 for 18% tax).
|
|
2928
|
+
* @property {number} [tax_amount] - The total monetary value of the tax
|
|
2929
|
+
* calculated for this component. This is derived by applying the tax rate to
|
|
2930
|
+
* the taxable amount.
|
|
2931
|
+
* @property {number} [taxable_amount] - The base amount on which the tax is
|
|
2932
|
+
* calculated, excluding the tax itself. This represents the value of goods or
|
|
2933
|
+
* services before tax is applied.
|
|
2934
|
+
*/
|
|
2920
2935
|
/**
|
|
2921
2936
|
* @typedef FinancialBreakup
|
|
2922
2937
|
* @property {number} refund_credit - The amount of refund credits applicable
|
|
@@ -2970,6 +2985,7 @@ export = OrderPlatformModel;
|
|
|
2970
2985
|
* @property {number} total_units - The total number of units involved in the transaction.
|
|
2971
2986
|
* @property {boolean} added_to_fynd_cash - Indicates whether the amount has
|
|
2972
2987
|
* been added to Fynd cash for future use.
|
|
2988
|
+
* @property {TaxComponent[]} [taxes] - Applied Tax Components
|
|
2973
2989
|
*/
|
|
2974
2990
|
/**
|
|
2975
2991
|
* @typedef GSTDetailsData
|
|
@@ -5084,7 +5100,7 @@ export = OrderPlatformModel;
|
|
|
5084
5100
|
declare class OrderPlatformModel {
|
|
5085
5101
|
}
|
|
5086
5102
|
declare namespace OrderPlatformModel {
|
|
5087
|
-
export { InvalidateShipmentCachePayload, InvalidateShipmentCacheNestedResponseSchema, InvalidateShipmentCacheResponseSchema, UpdatePackingErrorResponseSchema, ErrorResponseSchema, StoreReassign, StoreReassignResponseSchema, LockManagerEntities, UpdateShipmentLockPayload, OriginalFilter, Bags, CheckResponseSchema, UpdateShipmentLockResponseSchema, AnnouncementResponseSchema, AnnouncementsResponseSchema, BaseResponseSchema, ErrorDetail, ProductsReasonsFilters, ProductsReasonsData, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, OrderItemDataUpdates, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, OrderDataUpdates, SellerQCDetailsSchema, EntityStatusDataSchema, DataUpdatesFiltersSchema, EntityStatusDataUpdates, DataUpdates, TransitionComments, ShipmentsRequestSchema, UpdatedAddressSchema, UpdateAddressRequestBody, StatuesRequestSchema, UpdateShipmentStatusRequestSchema, ShipmentsResponseSchema, DPConfiguration, PaymentConfig, LockStateMessage, CreateOrderConfig, StatuesResponseSchema, UpdateShipmentStatusResponseBody, OrderUser, OrderPriority, ArticleDetails, LocationDetails, ShipmentDetails, ShipmentConfig, ShipmentData, MarketPlacePdf, AffiliateBag, UserData, OrderInfo, AffiliateAppConfigMeta, AffiliateAppConfig, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateInventoryOrderConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryConfig, AffiliateConfig, Affiliate, AffiliateStoreIdMapping, OrderConfig, CreateOrderResponseSchema, DispatchManifest, SuccessResponseSchema, ActionInfo, GetActionsResponseSchema, HistoryReason, RefundInformation, HistoryMeta, HistoryDict, ShipmentHistoryResponseSchema, PostHistoryFilters, PostHistoryData, PostHistoryDict, PostShipmentHistory, SmsDataPayload, SendSmsPayload, OrderDetails, Meta, ShipmentDetail, OrderStatusData, OrderStatusResult, SendSmsResponseSchema, Dimension, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponseSchema, Tax, AmountSchema, Charge, LineItem, ProcessingDates, Tag, ProcessAfterConfig, SystemMessages, Shipment, GeoLocationSchema, ShippingInfo, BillingInfo, UserInfo, TaxInfo, PaymentMethod, PaymentInfo, CreateOrderAPI, CreateOrderErrorReponse, PaymentMethods, CreateChannelPaymentInfo, CreateChannelConfig, CreateChannelConfigData, CreateChannelConifgErrorResponseSchema, UploadManifestConsent, CreateChannelConfigResponseSchema, PlatformOrderUpdate, ResponseDetail, FyndOrderIdList, OrderStatus, BagStateTransitionMap, RoleBaseStateTransitionMapping, FetchCreditBalanceRequestPayload, CreditBalanceInfo, FetchCreditBalanceResponsePayload, RefundModeConfigRequestPayload, RefundOption, RefundModeFormat, RefundModeInfo, RefundModeConfigResponsePayload, AttachUserOtpData, AttachUserInfo, AttachOrderUser, AttachOrderUserResponseSchema, SendUserMobileOTP, PointBlankOtpData, SendUserMobileOtpResponseSchema, VerifyOtpData, VerifyMobileOTP, VerifyOtpResponseData, VerifyOtpResponseSchema, BulkReportsFiltersSchema, BulkReportsDownloadRequestSchema, BulkReportsDownloadResponseSchema, APIFailedResponseSchema, BulkStateTransistionRequestSchema, BulkStateTransistionResponseSchema, ShipmentActionInfo, BulkActionListingData, BulkListinPage, BulkListingResponseSchema, JobDetailsData, JobDetailsResponseSchema, JobFailedResponseSchema, ManifestPageInfo, ManifestItemDetails, ManifestShipmentListing, DateRange, Filters, ManifestFile, ManifestMediaUpdate, PDFMeta, TotalShipmentPricesCount, ManifestMeta, Manifest, ManifestList, ManifestDetails, FiltersRequestSchema, ProcessManifest, ProcessManifestResponseSchema, ProcessManifestItemResponseSchema, FilterInfoOption, FiltersInfo, ManifestFiltersResponseSchema, PageDetails, EInvoiceIrnDetails, EInvoiceErrorDetails, EInvoiceDetails, EInvoiceResponseData, EInvoiceRetry, EInvoiceRetryResponseSchema, EInvoiceErrorInfo, EInvoiceErrorResponseData, EInvoiceErrorResponseSchema, EInvoiceErrorResponseDetails, EInvoiceRetryShipmentData, CourierPartnerTrackingDetails, CourierPartnerTrackingResponseSchema, LogsChannelDetails, LogPaymentDetails, FailedOrdersItem, FailedOrderLogs, FailedOrderLogDetails, GenerateInvoiceIDResponseData, GenerateInvoiceIDErrorResponseData, GenerateInvoiceIDRequestSchema, GenerateInvoiceIDResponseSchema, GenerateInvoiceIDErrorResponseSchema, ManifestResponseSchema, ProcessManifestRequestSchema, ManifestItems, ManifestErrorResponseSchema, ConfigData, ConfigUpdatedResponseSchema, FlagData, Flags, Filter, PostHook, PreHook, Config, TransitionConfigCondition, TransitionConfigData, TransitionConfigPayload, RuleListRequestSchema, RuleErrorResponseSchema, RMAPageInfo, RuleAction, QuestionSetItem, Reason, Conditions, RuleItem, RuleError, RuleListResponseSchema, UpdateShipmentPaymentMode, CommonErrorResponseSchema, ExceptionErrorResponseSchema, ProductSchema, PaymentMethodSchema, ActionDetailSchema, PaymentMetaDataSchema, PaymentMetaLogoURLSchema, ValidationError, Page, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentStatus, UserDataInfo, Address, ShipmentListingChannel, Prices, ChargeDistributionSchema, ChargeDistributionLogic, ChargeAmountCurrency, ChargeAmount, PriceAdjustmentCharge, OrderingCurrencyPrices, Identifier, FinancialBreakup, GSTDetailsData, BagStateMapper, BagStatusHistory, Dimensions, ReturnConfig, Weight, Article, ShipmentListingBrand, ReplacementDetails, AffiliateMeta, AffiliateBagDetails, PlatformArticleAttributes, PlatformItem, Dates, BagReturnableCancelableStatus, BagUnit, ShipmentItemFulFillingStore, Currency, OrderingCurrency, ConversionRate, CurrencyInfo, ShipmentItem, ShipmentInternalPlatformViewResponseSchema, TrackingList, InvoiceInfo, OrderDetailsData, UserDetailsData, PhoneDetails, ContactDetails, CompanyDetails, OrderingStoreDetails, DPDetailsData, BuyerDetails, DebugInfo, EinvoiceInfo, Formatted, ShipmentTags, LockData, ShipmentTimeStamp, ShipmentMeta, PDFLinks, AffiliateDetails, BagConfigs, OrderBagArticle, OrderBrandName, AffiliateBagsDetails, BagPaymentMethods, DiscountRules, ItemCriterias, BuyRules, PriceMinMax, ItemPriceDetails, FreeGiftItems, AppliedFreeArticles, AppliedPromos, CurrentStatus, OrderBags, FulfillingStore, ShipmentPayments, ShipmentStatusData, ShipmentLockDetails, FulfillmentOption, PlatformShipment, ShipmentInfoResponseSchema, TaxDetails, PaymentInfoData, CurrencySchema, OrderData, OrderDetailsResponseSchema, SubLane, SuperLane, LaneConfigResponseSchema, PlatformBreakupValues, PlatformChannel, PlatformOrderItems, OrderListingResponseSchema, PlatformTrack, PlatformShipmentTrack, AdvanceFilterInfo, FiltersResponseSchema, URL, FileResponseSchema, BulkActionTemplate, BulkActionTemplateResponseSchema, PlatformShipmentReasonsResponseSchema, ShipmentResponseReasons, ShipmentReasonsResponseSchema, StoreAddress, EInvoicePortalDetails, StoreEinvoice, StoreEwaybill, StoreGstCredentials, Document, StoreDocuments, StoreMeta, Store, Brand, Item, ArticleStatusDetails, Company, ShipmentGstDetails, DeliverySlotDetails, InvoiceDetails, UserDetails, WeightData, BagDetails, BagDetailsPlatformResponseSchema, BagsPage, BagData, GetBagsPlatformResponseSchema, GeneratePosOrderReceiptResponseSchema, Templates, AllowedTemplatesResponseSchema, TemplateDownloadResponseSchema, Error, BulkFailedResponseSchema, OrderingSource };
|
|
5103
|
+
export { InvalidateShipmentCachePayload, InvalidateShipmentCacheNestedResponseSchema, InvalidateShipmentCacheResponseSchema, UpdatePackingErrorResponseSchema, ErrorResponseSchema, StoreReassign, StoreReassignResponseSchema, LockManagerEntities, UpdateShipmentLockPayload, OriginalFilter, Bags, CheckResponseSchema, UpdateShipmentLockResponseSchema, AnnouncementResponseSchema, AnnouncementsResponseSchema, BaseResponseSchema, ErrorDetail, ProductsReasonsFilters, ProductsReasonsData, ProductsReasons, EntityReasonData, EntitiesReasons, ReasonsData, Products, OrderItemDataUpdates, ProductsDataUpdatesFilters, ProductsDataUpdates, EntitiesDataUpdates, OrderDataUpdates, SellerQCDetailsSchema, EntityStatusDataSchema, DataUpdatesFiltersSchema, EntityStatusDataUpdates, DataUpdates, TransitionComments, ShipmentsRequestSchema, UpdatedAddressSchema, UpdateAddressRequestBody, StatuesRequestSchema, UpdateShipmentStatusRequestSchema, ShipmentsResponseSchema, DPConfiguration, PaymentConfig, LockStateMessage, CreateOrderConfig, StatuesResponseSchema, UpdateShipmentStatusResponseBody, OrderUser, OrderPriority, ArticleDetails, LocationDetails, ShipmentDetails, ShipmentConfig, ShipmentData, MarketPlacePdf, AffiliateBag, UserData, OrderInfo, AffiliateAppConfigMeta, AffiliateAppConfig, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateInventoryOrderConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryConfig, AffiliateConfig, Affiliate, AffiliateStoreIdMapping, OrderConfig, CreateOrderResponseSchema, DispatchManifest, SuccessResponseSchema, ActionInfo, GetActionsResponseSchema, HistoryReason, RefundInformation, HistoryMeta, HistoryDict, ShipmentHistoryResponseSchema, PostHistoryFilters, PostHistoryData, PostHistoryDict, PostShipmentHistory, SmsDataPayload, SendSmsPayload, OrderDetails, Meta, ShipmentDetail, OrderStatusData, OrderStatusResult, SendSmsResponseSchema, Dimension, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponseSchema, Tax, AmountSchema, Charge, LineItem, ProcessingDates, Tag, ProcessAfterConfig, SystemMessages, Shipment, GeoLocationSchema, ShippingInfo, BillingInfo, UserInfo, TaxInfo, PaymentMethod, PaymentInfo, CreateOrderAPI, CreateOrderErrorReponse, PaymentMethods, CreateChannelPaymentInfo, CreateChannelConfig, CreateChannelConfigData, CreateChannelConifgErrorResponseSchema, UploadManifestConsent, CreateChannelConfigResponseSchema, PlatformOrderUpdate, ResponseDetail, FyndOrderIdList, OrderStatus, BagStateTransitionMap, RoleBaseStateTransitionMapping, FetchCreditBalanceRequestPayload, CreditBalanceInfo, FetchCreditBalanceResponsePayload, RefundModeConfigRequestPayload, RefundOption, RefundModeFormat, RefundModeInfo, RefundModeConfigResponsePayload, AttachUserOtpData, AttachUserInfo, AttachOrderUser, AttachOrderUserResponseSchema, SendUserMobileOTP, PointBlankOtpData, SendUserMobileOtpResponseSchema, VerifyOtpData, VerifyMobileOTP, VerifyOtpResponseData, VerifyOtpResponseSchema, BulkReportsFiltersSchema, BulkReportsDownloadRequestSchema, BulkReportsDownloadResponseSchema, APIFailedResponseSchema, BulkStateTransistionRequestSchema, BulkStateTransistionResponseSchema, ShipmentActionInfo, BulkActionListingData, BulkListinPage, BulkListingResponseSchema, JobDetailsData, JobDetailsResponseSchema, JobFailedResponseSchema, ManifestPageInfo, ManifestItemDetails, ManifestShipmentListing, DateRange, Filters, ManifestFile, ManifestMediaUpdate, PDFMeta, TotalShipmentPricesCount, ManifestMeta, Manifest, ManifestList, ManifestDetails, FiltersRequestSchema, ProcessManifest, ProcessManifestResponseSchema, ProcessManifestItemResponseSchema, FilterInfoOption, FiltersInfo, ManifestFiltersResponseSchema, PageDetails, EInvoiceIrnDetails, EInvoiceErrorDetails, EInvoiceDetails, EInvoiceResponseData, EInvoiceRetry, EInvoiceRetryResponseSchema, EInvoiceErrorInfo, EInvoiceErrorResponseData, EInvoiceErrorResponseSchema, EInvoiceErrorResponseDetails, EInvoiceRetryShipmentData, CourierPartnerTrackingDetails, CourierPartnerTrackingResponseSchema, LogsChannelDetails, LogPaymentDetails, FailedOrdersItem, FailedOrderLogs, FailedOrderLogDetails, GenerateInvoiceIDResponseData, GenerateInvoiceIDErrorResponseData, GenerateInvoiceIDRequestSchema, GenerateInvoiceIDResponseSchema, GenerateInvoiceIDErrorResponseSchema, ManifestResponseSchema, ProcessManifestRequestSchema, ManifestItems, ManifestErrorResponseSchema, ConfigData, ConfigUpdatedResponseSchema, FlagData, Flags, Filter, PostHook, PreHook, Config, TransitionConfigCondition, TransitionConfigData, TransitionConfigPayload, RuleListRequestSchema, RuleErrorResponseSchema, RMAPageInfo, RuleAction, QuestionSetItem, Reason, Conditions, RuleItem, RuleError, RuleListResponseSchema, UpdateShipmentPaymentMode, CommonErrorResponseSchema, ExceptionErrorResponseSchema, ProductSchema, PaymentMethodSchema, ActionDetailSchema, PaymentMetaDataSchema, PaymentMetaLogoURLSchema, ValidationError, Page, BagReasonMeta, QuestionSet, BagReasons, ShipmentBagReasons, ShipmentStatus, UserDataInfo, Address, ShipmentListingChannel, Prices, ChargeDistributionSchema, ChargeDistributionLogic, ChargeAmountCurrency, ChargeAmount, PriceAdjustmentCharge, OrderingCurrencyPrices, Identifier, TaxComponent, FinancialBreakup, GSTDetailsData, BagStateMapper, BagStatusHistory, Dimensions, ReturnConfig, Weight, Article, ShipmentListingBrand, ReplacementDetails, AffiliateMeta, AffiliateBagDetails, PlatformArticleAttributes, PlatformItem, Dates, BagReturnableCancelableStatus, BagUnit, ShipmentItemFulFillingStore, Currency, OrderingCurrency, ConversionRate, CurrencyInfo, ShipmentItem, ShipmentInternalPlatformViewResponseSchema, TrackingList, InvoiceInfo, OrderDetailsData, UserDetailsData, PhoneDetails, ContactDetails, CompanyDetails, OrderingStoreDetails, DPDetailsData, BuyerDetails, DebugInfo, EinvoiceInfo, Formatted, ShipmentTags, LockData, ShipmentTimeStamp, ShipmentMeta, PDFLinks, AffiliateDetails, BagConfigs, OrderBagArticle, OrderBrandName, AffiliateBagsDetails, BagPaymentMethods, DiscountRules, ItemCriterias, BuyRules, PriceMinMax, ItemPriceDetails, FreeGiftItems, AppliedFreeArticles, AppliedPromos, CurrentStatus, OrderBags, FulfillingStore, ShipmentPayments, ShipmentStatusData, ShipmentLockDetails, FulfillmentOption, PlatformShipment, ShipmentInfoResponseSchema, TaxDetails, PaymentInfoData, CurrencySchema, OrderData, OrderDetailsResponseSchema, SubLane, SuperLane, LaneConfigResponseSchema, PlatformBreakupValues, PlatformChannel, PlatformOrderItems, OrderListingResponseSchema, PlatformTrack, PlatformShipmentTrack, AdvanceFilterInfo, FiltersResponseSchema, URL, FileResponseSchema, BulkActionTemplate, BulkActionTemplateResponseSchema, PlatformShipmentReasonsResponseSchema, ShipmentResponseReasons, ShipmentReasonsResponseSchema, StoreAddress, EInvoicePortalDetails, StoreEinvoice, StoreEwaybill, StoreGstCredentials, Document, StoreDocuments, StoreMeta, Store, Brand, Item, ArticleStatusDetails, Company, ShipmentGstDetails, DeliverySlotDetails, InvoiceDetails, UserDetails, WeightData, BagDetails, BagDetailsPlatformResponseSchema, BagsPage, BagData, GetBagsPlatformResponseSchema, GeneratePosOrderReceiptResponseSchema, Templates, AllowedTemplatesResponseSchema, TemplateDownloadResponseSchema, Error, BulkFailedResponseSchema, OrderingSource };
|
|
5088
5104
|
}
|
|
5089
5105
|
/** @returns {InvalidateShipmentCachePayload} */
|
|
5090
5106
|
declare function InvalidateShipmentCachePayload(): InvalidateShipmentCachePayload;
|
|
@@ -11013,6 +11029,34 @@ type Identifier = {
|
|
|
11013
11029
|
*/
|
|
11014
11030
|
isbn?: string;
|
|
11015
11031
|
};
|
|
11032
|
+
/** @returns {TaxComponent} */
|
|
11033
|
+
declare function TaxComponent(): TaxComponent;
|
|
11034
|
+
type TaxComponent = {
|
|
11035
|
+
/**
|
|
11036
|
+
* - The name or type of the tax component (e.g., GST,
|
|
11037
|
+
* VAT, Service Tax). This helps in identifying the specific tax being applied
|
|
11038
|
+
* to the transaction or item.
|
|
11039
|
+
*/
|
|
11040
|
+
name?: string;
|
|
11041
|
+
/**
|
|
11042
|
+
* - The percentage rate at which the tax is applied
|
|
11043
|
+
* to the taxable amount. This value is typically represented as a decimal
|
|
11044
|
+
* (e.g., 0.18 for 18% tax).
|
|
11045
|
+
*/
|
|
11046
|
+
rate?: number;
|
|
11047
|
+
/**
|
|
11048
|
+
* - The total monetary value of the tax
|
|
11049
|
+
* calculated for this component. This is derived by applying the tax rate to
|
|
11050
|
+
* the taxable amount.
|
|
11051
|
+
*/
|
|
11052
|
+
tax_amount?: number;
|
|
11053
|
+
/**
|
|
11054
|
+
* - The base amount on which the tax is
|
|
11055
|
+
* calculated, excluding the tax itself. This represents the value of goods or
|
|
11056
|
+
* services before tax is applied.
|
|
11057
|
+
*/
|
|
11058
|
+
taxable_amount?: number;
|
|
11059
|
+
};
|
|
11016
11060
|
/** @returns {FinancialBreakup} */
|
|
11017
11061
|
declare function FinancialBreakup(): FinancialBreakup;
|
|
11018
11062
|
type FinancialBreakup = {
|
|
@@ -11148,6 +11192,10 @@ type FinancialBreakup = {
|
|
|
11148
11192
|
* been added to Fynd cash for future use.
|
|
11149
11193
|
*/
|
|
11150
11194
|
added_to_fynd_cash: boolean;
|
|
11195
|
+
/**
|
|
11196
|
+
* - Applied Tax Components
|
|
11197
|
+
*/
|
|
11198
|
+
taxes?: TaxComponent[];
|
|
11151
11199
|
};
|
|
11152
11200
|
/** @returns {GSTDetailsData} */
|
|
11153
11201
|
declare function GSTDetailsData(): GSTDetailsData;
|
|
@@ -3171,6 +3171,22 @@ const Joi = require("joi");
|
|
|
3171
3171
|
* of book inventories in retail and library systems.
|
|
3172
3172
|
*/
|
|
3173
3173
|
|
|
3174
|
+
/**
|
|
3175
|
+
* @typedef TaxComponent
|
|
3176
|
+
* @property {string} [name] - The name or type of the tax component (e.g., GST,
|
|
3177
|
+
* VAT, Service Tax). This helps in identifying the specific tax being applied
|
|
3178
|
+
* to the transaction or item.
|
|
3179
|
+
* @property {number} [rate] - The percentage rate at which the tax is applied
|
|
3180
|
+
* to the taxable amount. This value is typically represented as a decimal
|
|
3181
|
+
* (e.g., 0.18 for 18% tax).
|
|
3182
|
+
* @property {number} [tax_amount] - The total monetary value of the tax
|
|
3183
|
+
* calculated for this component. This is derived by applying the tax rate to
|
|
3184
|
+
* the taxable amount.
|
|
3185
|
+
* @property {number} [taxable_amount] - The base amount on which the tax is
|
|
3186
|
+
* calculated, excluding the tax itself. This represents the value of goods or
|
|
3187
|
+
* services before tax is applied.
|
|
3188
|
+
*/
|
|
3189
|
+
|
|
3174
3190
|
/**
|
|
3175
3191
|
* @typedef FinancialBreakup
|
|
3176
3192
|
* @property {number} refund_credit - The amount of refund credits applicable
|
|
@@ -3224,6 +3240,7 @@ const Joi = require("joi");
|
|
|
3224
3240
|
* @property {number} total_units - The total number of units involved in the transaction.
|
|
3225
3241
|
* @property {boolean} added_to_fynd_cash - Indicates whether the amount has
|
|
3226
3242
|
* been added to Fynd cash for future use.
|
|
3243
|
+
* @property {TaxComponent[]} [taxes] - Applied Tax Components
|
|
3227
3244
|
*/
|
|
3228
3245
|
|
|
3229
3246
|
/**
|
|
@@ -8319,6 +8336,16 @@ class OrderPlatformModel {
|
|
|
8319
8336
|
});
|
|
8320
8337
|
}
|
|
8321
8338
|
|
|
8339
|
+
/** @returns {TaxComponent} */
|
|
8340
|
+
static TaxComponent() {
|
|
8341
|
+
return Joi.object({
|
|
8342
|
+
name: Joi.string().allow(""),
|
|
8343
|
+
rate: Joi.number(),
|
|
8344
|
+
tax_amount: Joi.number(),
|
|
8345
|
+
taxable_amount: Joi.number(),
|
|
8346
|
+
});
|
|
8347
|
+
}
|
|
8348
|
+
|
|
8322
8349
|
/** @returns {FinancialBreakup} */
|
|
8323
8350
|
static FinancialBreakup() {
|
|
8324
8351
|
return Joi.object({
|
|
@@ -8350,6 +8377,7 @@ class OrderPlatformModel {
|
|
|
8350
8377
|
identifiers: OrderPlatformModel.Identifier().required(),
|
|
8351
8378
|
total_units: Joi.number().required(),
|
|
8352
8379
|
added_to_fynd_cash: Joi.boolean().required(),
|
|
8380
|
+
taxes: Joi.array().items(OrderPlatformModel.TaxComponent()),
|
|
8353
8381
|
});
|
|
8354
8382
|
}
|
|
8355
8383
|
|
|
@@ -13,7 +13,7 @@ declare class APIClient {
|
|
|
13
13
|
* @param {object} xHeaders
|
|
14
14
|
* @param {Options} options
|
|
15
15
|
*/
|
|
16
|
-
static execute(conf: object, method: string, url: string, query: object, body: object, xHeaders: object, options: Options): Promise<import("axios").AxiosResponse<any, any>>;
|
|
16
|
+
static execute(conf: object, method: string, url: string, query: object, body: object, xHeaders: object, options: Options): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
17
17
|
get(url: any, config: any): Promise<any>;
|
|
18
18
|
}
|
|
19
19
|
declare namespace APIClient {
|
|
@@ -52,8 +52,8 @@ declare class PlatformClient {
|
|
|
52
52
|
body: any;
|
|
53
53
|
headers: any;
|
|
54
54
|
responseHeaders?: boolean;
|
|
55
|
-
}): Promise<import("axios").AxiosResponse<any, any>>;
|
|
56
|
-
getAccesstokenObj(options: any): Promise<import("axios").AxiosResponse<any, any>>;
|
|
55
|
+
}): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
56
|
+
getAccesstokenObj(options: any): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
57
57
|
setToken(token: any): void;
|
|
58
58
|
}
|
|
59
59
|
import PlatformConfig = require("./PlatformConfig");
|
|
@@ -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({
|