@gofynd/fdk-client-javascript 3.5.0 → 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/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/ServiceabilityPlatformModel.d.ts +0 -10
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +0 -4
- package/sdk/public/PublicAPIClient.d.ts +1 -1
|
@@ -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");
|
|
@@ -730,7 +730,6 @@ export = ServiceabilityPlatformModel;
|
|
|
730
730
|
* @property {number} [company_id] - The unique identifier for the company.
|
|
731
731
|
* @property {string} name - The name of the package material.
|
|
732
732
|
* @property {string} [id] - Unique identifier for the package material.
|
|
733
|
-
* @property {number} [item_id] - Unique identifier for the item.
|
|
734
733
|
* @property {number} width - The width of the package material.
|
|
735
734
|
* @property {number} height - The height of the package material.
|
|
736
735
|
* @property {number} length - The length of the package material.
|
|
@@ -805,7 +804,6 @@ export = ServiceabilityPlatformModel;
|
|
|
805
804
|
* @property {boolean} [is_active] - Indicates if the package item is active.
|
|
806
805
|
* @property {string} [size] - The size of the package item.
|
|
807
806
|
* @property {number} [company_id] - The company ID associated with the package item.
|
|
808
|
-
* @property {number} [item_id] - The unique identifier for the package item.
|
|
809
807
|
* @property {number} [max_weight] - The maximum weight(grams) of the package item.
|
|
810
808
|
* @property {Object[]} [media] - Additional media associated with the package item.
|
|
811
809
|
* @property {number} [package_vol_weight] - The volumetric weight(grams) of the
|
|
@@ -4151,10 +4149,6 @@ type PackageMaterialResult = {
|
|
|
4151
4149
|
* - Unique identifier for the package material.
|
|
4152
4150
|
*/
|
|
4153
4151
|
id?: string;
|
|
4154
|
-
/**
|
|
4155
|
-
* - Unique identifier for the item.
|
|
4156
|
-
*/
|
|
4157
|
-
item_id?: number;
|
|
4158
4152
|
/**
|
|
4159
4153
|
* - The width of the package material.
|
|
4160
4154
|
*/
|
|
@@ -4353,10 +4347,6 @@ type PackageItem = {
|
|
|
4353
4347
|
* - The company ID associated with the package item.
|
|
4354
4348
|
*/
|
|
4355
4349
|
company_id?: number;
|
|
4356
|
-
/**
|
|
4357
|
-
* - The unique identifier for the package item.
|
|
4358
|
-
*/
|
|
4359
|
-
item_id?: number;
|
|
4360
4350
|
/**
|
|
4361
4351
|
* - The maximum weight(grams) of the package item.
|
|
4362
4352
|
*/
|
|
@@ -804,7 +804,6 @@ const Joi = require("joi");
|
|
|
804
804
|
* @property {number} [company_id] - The unique identifier for the company.
|
|
805
805
|
* @property {string} name - The name of the package material.
|
|
806
806
|
* @property {string} [id] - Unique identifier for the package material.
|
|
807
|
-
* @property {number} [item_id] - Unique identifier for the item.
|
|
808
807
|
* @property {number} width - The width of the package material.
|
|
809
808
|
* @property {number} height - The height of the package material.
|
|
810
809
|
* @property {number} length - The length of the package material.
|
|
@@ -883,7 +882,6 @@ const Joi = require("joi");
|
|
|
883
882
|
* @property {boolean} [is_active] - Indicates if the package item is active.
|
|
884
883
|
* @property {string} [size] - The size of the package item.
|
|
885
884
|
* @property {number} [company_id] - The company ID associated with the package item.
|
|
886
|
-
* @property {number} [item_id] - The unique identifier for the package item.
|
|
887
885
|
* @property {number} [max_weight] - The maximum weight(grams) of the package item.
|
|
888
886
|
* @property {Object[]} [media] - Additional media associated with the package item.
|
|
889
887
|
* @property {number} [package_vol_weight] - The volumetric weight(grams) of the
|
|
@@ -3425,7 +3423,6 @@ class ServiceabilityPlatformModel {
|
|
|
3425
3423
|
company_id: Joi.number(),
|
|
3426
3424
|
name: Joi.string().allow("").required(),
|
|
3427
3425
|
id: Joi.string().allow(""),
|
|
3428
|
-
item_id: Joi.number(),
|
|
3429
3426
|
width: Joi.number().required(),
|
|
3430
3427
|
height: Joi.number().required(),
|
|
3431
3428
|
length: Joi.number().required(),
|
|
@@ -3505,7 +3502,6 @@ class ServiceabilityPlatformModel {
|
|
|
3505
3502
|
is_active: Joi.boolean(),
|
|
3506
3503
|
size: Joi.string().allow(""),
|
|
3507
3504
|
company_id: Joi.number(),
|
|
3508
|
-
item_id: Joi.number(),
|
|
3509
3505
|
max_weight: Joi.number(),
|
|
3510
3506
|
media: Joi.array().items(Joi.any()),
|
|
3511
3507
|
package_vol_weight: Joi.number(),
|
|
@@ -11,7 +11,7 @@ declare class PublicAPIClient {
|
|
|
11
11
|
* @param {object} query
|
|
12
12
|
* @param {object} body
|
|
13
13
|
*/
|
|
14
|
-
static execute(conf: object, method: string, url: string, query: object, body: object, xHeaders: any, options: any): Promise<import("axios").AxiosResponse<any, any>>;
|
|
14
|
+
static execute(conf: object, method: string, url: string, query: object, body: object, xHeaders: any, options: any): Promise<import("axios").AxiosResponse<any, any, {}>>;
|
|
15
15
|
}
|
|
16
16
|
declare namespace PublicAPIClient {
|
|
17
17
|
export { Options };
|