@gofynd/fdk-client-javascript 3.6.0 → 3.7.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/Payment/PaymentApplicationClient.d.ts +0 -50
- package/sdk/application/Payment/PaymentApplicationClient.js +0 -210
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +4 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +2 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +1 -125
- package/sdk/platform/Catalog/CatalogPlatformClient.js +131 -1111
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +228 -1009
- package/sdk/platform/Catalog/CatalogPlatformModel.js +102 -681
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +5 -200
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +4 -174
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +4 -9
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +4 -4
- package/sdk/platform/Order/OrderPlatformModel.d.ts +8 -60
- package/sdk/platform/Order/OrderPlatformModel.js +3 -33
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +3 -2
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +10 -6
- package/sdk/platform/Partner/PartnerPlatformModel.js +5 -3
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +10 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +4 -0
|
@@ -58,9 +58,8 @@ export = FileStoragePlatformModel;
|
|
|
58
58
|
*/
|
|
59
59
|
/**
|
|
60
60
|
* @typedef ProxyFileAccess
|
|
61
|
-
* @property {
|
|
62
|
-
*
|
|
63
|
-
* fetched and processed.
|
|
61
|
+
* @property {Object} [data]
|
|
62
|
+
* @property {Object} [support]
|
|
64
63
|
*/
|
|
65
64
|
/**
|
|
66
65
|
* @typedef DestinationNamespace
|
|
@@ -272,12 +271,8 @@ type FileUploadComplete = {
|
|
|
272
271
|
/** @returns {ProxyFileAccess} */
|
|
273
272
|
declare function ProxyFileAccess(): ProxyFileAccess;
|
|
274
273
|
type ProxyFileAccess = {
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
* request was successful. Returns true when the external URL was successfully
|
|
278
|
-
* fetched and processed.
|
|
279
|
-
*/
|
|
280
|
-
success?: boolean;
|
|
274
|
+
data?: any;
|
|
275
|
+
support?: any;
|
|
281
276
|
};
|
|
282
277
|
/** @returns {DestinationNamespace} */
|
|
283
278
|
declare function DestinationNamespace(): DestinationNamespace;
|
|
@@ -66,9 +66,8 @@ const Joi = require("joi");
|
|
|
66
66
|
|
|
67
67
|
/**
|
|
68
68
|
* @typedef ProxyFileAccess
|
|
69
|
-
* @property {
|
|
70
|
-
*
|
|
71
|
-
* fetched and processed.
|
|
69
|
+
* @property {Object} [data]
|
|
70
|
+
* @property {Object} [support]
|
|
72
71
|
*/
|
|
73
72
|
|
|
74
73
|
/**
|
|
@@ -311,7 +310,8 @@ class FileStoragePlatformModel {
|
|
|
311
310
|
/** @returns {ProxyFileAccess} */
|
|
312
311
|
static ProxyFileAccess() {
|
|
313
312
|
return Joi.object({
|
|
314
|
-
|
|
313
|
+
data: Joi.object().pattern(/\S/, Joi.any()),
|
|
314
|
+
support: Joi.object().pattern(/\S/, Joi.any()),
|
|
315
315
|
});
|
|
316
316
|
}
|
|
317
317
|
|
|
@@ -2917,21 +2917,6 @@ 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
|
-
*/
|
|
2935
2920
|
/**
|
|
2936
2921
|
* @typedef FinancialBreakup
|
|
2937
2922
|
* @property {number} refund_credit - The amount of refund credits applicable
|
|
@@ -2985,7 +2970,6 @@ export = OrderPlatformModel;
|
|
|
2985
2970
|
* @property {number} total_units - The total number of units involved in the transaction.
|
|
2986
2971
|
* @property {boolean} added_to_fynd_cash - Indicates whether the amount has
|
|
2987
2972
|
* been added to Fynd cash for future use.
|
|
2988
|
-
* @property {TaxComponent[]} [taxes] - Applied Tax Components
|
|
2989
2973
|
*/
|
|
2990
2974
|
/**
|
|
2991
2975
|
* @typedef GSTDetailsData
|
|
@@ -3134,10 +3118,6 @@ export = OrderPlatformModel;
|
|
|
3134
3118
|
*/
|
|
3135
3119
|
/**
|
|
3136
3120
|
* @typedef Article
|
|
3137
|
-
* @property {Object} [child_details] - Contains a flexible set of key-value
|
|
3138
|
-
* pairs representing detailed information about the article's child entities,
|
|
3139
|
-
* including dimensions (width, height, length), weight, and unique
|
|
3140
|
-
* identifiers (EAN, article code, seller identifier) for each child entity.
|
|
3141
3121
|
* @property {string} seller_identifier - Unique identifier assigned by the
|
|
3142
3122
|
* seller to the article, used for inventory management.
|
|
3143
3123
|
* @property {string} uid - A unique identifier for the article within the system.
|
|
@@ -3165,6 +3145,8 @@ export = OrderPlatformModel;
|
|
|
3165
3145
|
* or collection.
|
|
3166
3146
|
* @property {string[]} [tags] - Tags associated with the article for
|
|
3167
3147
|
* categorization and search optimization.
|
|
3148
|
+
* @property {Object} [_custom_json] - A custom JSON object containing
|
|
3149
|
+
* additional details or configurations specific to the article.
|
|
3168
3150
|
*/
|
|
3169
3151
|
/**
|
|
3170
3152
|
* @typedef ShipmentListingBrand
|
|
@@ -5100,7 +5082,7 @@ export = OrderPlatformModel;
|
|
|
5100
5082
|
declare class OrderPlatformModel {
|
|
5101
5083
|
}
|
|
5102
5084
|
declare namespace OrderPlatformModel {
|
|
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,
|
|
5085
|
+
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 };
|
|
5104
5086
|
}
|
|
5105
5087
|
/** @returns {InvalidateShipmentCachePayload} */
|
|
5106
5088
|
declare function InvalidateShipmentCachePayload(): InvalidateShipmentCachePayload;
|
|
@@ -11029,34 +11011,6 @@ type Identifier = {
|
|
|
11029
11011
|
*/
|
|
11030
11012
|
isbn?: string;
|
|
11031
11013
|
};
|
|
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
|
-
};
|
|
11060
11014
|
/** @returns {FinancialBreakup} */
|
|
11061
11015
|
declare function FinancialBreakup(): FinancialBreakup;
|
|
11062
11016
|
type FinancialBreakup = {
|
|
@@ -11192,10 +11146,6 @@ type FinancialBreakup = {
|
|
|
11192
11146
|
* been added to Fynd cash for future use.
|
|
11193
11147
|
*/
|
|
11194
11148
|
added_to_fynd_cash: boolean;
|
|
11195
|
-
/**
|
|
11196
|
-
* - Applied Tax Components
|
|
11197
|
-
*/
|
|
11198
|
-
taxes?: TaxComponent[];
|
|
11199
11149
|
};
|
|
11200
11150
|
/** @returns {GSTDetailsData} */
|
|
11201
11151
|
declare function GSTDetailsData(): GSTDetailsData;
|
|
@@ -11512,13 +11462,6 @@ type Weight = {
|
|
|
11512
11462
|
/** @returns {Article} */
|
|
11513
11463
|
declare function Article(): Article;
|
|
11514
11464
|
type Article = {
|
|
11515
|
-
/**
|
|
11516
|
-
* - Contains a flexible set of key-value
|
|
11517
|
-
* pairs representing detailed information about the article's child entities,
|
|
11518
|
-
* including dimensions (width, height, length), weight, and unique
|
|
11519
|
-
* identifiers (EAN, article code, seller identifier) for each child entity.
|
|
11520
|
-
*/
|
|
11521
|
-
child_details?: any;
|
|
11522
11465
|
/**
|
|
11523
11466
|
* - Unique identifier assigned by the
|
|
11524
11467
|
* seller to the article, used for inventory management.
|
|
@@ -11585,6 +11528,11 @@ type Article = {
|
|
|
11585
11528
|
* categorization and search optimization.
|
|
11586
11529
|
*/
|
|
11587
11530
|
tags?: string[];
|
|
11531
|
+
/**
|
|
11532
|
+
* - A custom JSON object containing
|
|
11533
|
+
* additional details or configurations specific to the article.
|
|
11534
|
+
*/
|
|
11535
|
+
_custom_json?: any;
|
|
11588
11536
|
};
|
|
11589
11537
|
/** @returns {ShipmentListingBrand} */
|
|
11590
11538
|
declare function ShipmentListingBrand(): ShipmentListingBrand;
|
|
@@ -3171,22 +3171,6 @@ 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
|
-
|
|
3190
3174
|
/**
|
|
3191
3175
|
* @typedef FinancialBreakup
|
|
3192
3176
|
* @property {number} refund_credit - The amount of refund credits applicable
|
|
@@ -3240,7 +3224,6 @@ const Joi = require("joi");
|
|
|
3240
3224
|
* @property {number} total_units - The total number of units involved in the transaction.
|
|
3241
3225
|
* @property {boolean} added_to_fynd_cash - Indicates whether the amount has
|
|
3242
3226
|
* been added to Fynd cash for future use.
|
|
3243
|
-
* @property {TaxComponent[]} [taxes] - Applied Tax Components
|
|
3244
3227
|
*/
|
|
3245
3228
|
|
|
3246
3229
|
/**
|
|
@@ -3396,10 +3379,6 @@ const Joi = require("joi");
|
|
|
3396
3379
|
|
|
3397
3380
|
/**
|
|
3398
3381
|
* @typedef Article
|
|
3399
|
-
* @property {Object} [child_details] - Contains a flexible set of key-value
|
|
3400
|
-
* pairs representing detailed information about the article's child entities,
|
|
3401
|
-
* including dimensions (width, height, length), weight, and unique
|
|
3402
|
-
* identifiers (EAN, article code, seller identifier) for each child entity.
|
|
3403
3382
|
* @property {string} seller_identifier - Unique identifier assigned by the
|
|
3404
3383
|
* seller to the article, used for inventory management.
|
|
3405
3384
|
* @property {string} uid - A unique identifier for the article within the system.
|
|
@@ -3427,6 +3406,8 @@ const Joi = require("joi");
|
|
|
3427
3406
|
* or collection.
|
|
3428
3407
|
* @property {string[]} [tags] - Tags associated with the article for
|
|
3429
3408
|
* categorization and search optimization.
|
|
3409
|
+
* @property {Object} [_custom_json] - A custom JSON object containing
|
|
3410
|
+
* additional details or configurations specific to the article.
|
|
3430
3411
|
*/
|
|
3431
3412
|
|
|
3432
3413
|
/**
|
|
@@ -8336,16 +8317,6 @@ class OrderPlatformModel {
|
|
|
8336
8317
|
});
|
|
8337
8318
|
}
|
|
8338
8319
|
|
|
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
|
-
|
|
8349
8320
|
/** @returns {FinancialBreakup} */
|
|
8350
8321
|
static FinancialBreakup() {
|
|
8351
8322
|
return Joi.object({
|
|
@@ -8377,7 +8348,6 @@ class OrderPlatformModel {
|
|
|
8377
8348
|
identifiers: OrderPlatformModel.Identifier().required(),
|
|
8378
8349
|
total_units: Joi.number().required(),
|
|
8379
8350
|
added_to_fynd_cash: Joi.boolean().required(),
|
|
8380
|
-
taxes: Joi.array().items(OrderPlatformModel.TaxComponent()),
|
|
8381
8351
|
});
|
|
8382
8352
|
}
|
|
8383
8353
|
|
|
@@ -8476,7 +8446,6 @@ class OrderPlatformModel {
|
|
|
8476
8446
|
/** @returns {Article} */
|
|
8477
8447
|
static Article() {
|
|
8478
8448
|
return Joi.object({
|
|
8479
|
-
child_details: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
|
|
8480
8449
|
seller_identifier: Joi.string().allow("").required(),
|
|
8481
8450
|
uid: Joi.string().allow("").required(),
|
|
8482
8451
|
set: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
|
|
@@ -8492,6 +8461,7 @@ class OrderPlatformModel {
|
|
|
8492
8461
|
size: Joi.string().allow("").required(),
|
|
8493
8462
|
is_set: Joi.boolean().allow(null),
|
|
8494
8463
|
tags: Joi.array().items(Joi.string().allow("")).allow(null, ""),
|
|
8464
|
+
_custom_json: Joi.object().pattern(/\S/, Joi.any()),
|
|
8495
8465
|
});
|
|
8496
8466
|
}
|
|
8497
8467
|
|
|
@@ -11,7 +11,7 @@ declare class Partner {
|
|
|
11
11
|
* Success response
|
|
12
12
|
* @name addProxyPath
|
|
13
13
|
* @summary: Create extension proxy
|
|
14
|
-
* @description:
|
|
14
|
+
* @description: Use this endpoint to register a proxy for calling an extension's API from your storefront. This enables your storefront to interact with extension APIs seamlessly, helps enhance and extend your storefront's existing functionality using extensions, and simplifies integration by avoiding CORS issues when accessing extension APIs. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/partner/addProxyPath/).
|
|
15
15
|
*/
|
|
16
16
|
addProxyPath({ extensionId, body, requestHeaders }?: PartnerPlatformApplicationValidator.AddProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.ExtensionProxyPathCreation>;
|
|
17
17
|
/**
|
|
@@ -22,7 +22,7 @@ declare class Partner {
|
|
|
22
22
|
* Success response
|
|
23
23
|
* @name removeProxyPath
|
|
24
24
|
* @summary: Remove extension proxy
|
|
25
|
-
* @description: Remove the proxy
|
|
25
|
+
* @description: Remove the proxy that was created earlier for the extension. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/partner/removeProxyPath/).
|
|
26
26
|
*/
|
|
27
27
|
removeProxyPath({ extensionId, attachedPath, requestHeaders }?: PartnerPlatformApplicationValidator.RemoveProxyPathParam, { responseHeaders }?: object): Promise<PartnerPlatformModel.ExtensionProxyPathDelete>;
|
|
28
28
|
}
|
|
@@ -23,7 +23,7 @@ class Partner {
|
|
|
23
23
|
* Success response
|
|
24
24
|
* @name addProxyPath
|
|
25
25
|
* @summary: Create extension proxy
|
|
26
|
-
* @description:
|
|
26
|
+
* @description: Use this endpoint to register a proxy for calling an extension's API from your storefront. This enables your storefront to interact with extension APIs seamlessly, helps enhance and extend your storefront's existing functionality using extensions, and simplifies integration by avoiding CORS issues when accessing extension APIs. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/partner/addProxyPath/).
|
|
27
27
|
*/
|
|
28
28
|
async addProxyPath(
|
|
29
29
|
{ extensionId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -105,7 +105,7 @@ class Partner {
|
|
|
105
105
|
* Success response
|
|
106
106
|
* @name removeProxyPath
|
|
107
107
|
* @summary: Remove extension proxy
|
|
108
|
-
* @description: Remove the proxy
|
|
108
|
+
* @description: Remove the proxy that was created earlier for the extension. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/partner/removeProxyPath/).
|
|
109
109
|
*/
|
|
110
110
|
async removeProxyPath(
|
|
111
111
|
{ extensionId, attachedPath, requestHeaders } = { requestHeaders: {} },
|
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
export = PartnerPlatformApplicationValidator;
|
|
2
2
|
/**
|
|
3
3
|
* @typedef AddProxyPathParam
|
|
4
|
-
* @property {string} extensionId - Extension
|
|
4
|
+
* @property {string} extensionId - Extension's unique identifier for which a
|
|
5
|
+
* proxy URL will be generated
|
|
5
6
|
* @property {PartnerPlatformModel.AddProxyReq} body
|
|
6
7
|
*/
|
|
7
8
|
/**
|
|
8
9
|
* @typedef RemoveProxyPathParam
|
|
9
|
-
* @property {string} extensionId - Extension
|
|
10
|
+
* @property {string} extensionId - Extension ID for which proxy URL needs to be removed
|
|
10
11
|
* @property {string} attachedPath - Attached path slug
|
|
11
12
|
*/
|
|
12
13
|
declare class PartnerPlatformApplicationValidator {
|
|
@@ -20,14 +21,15 @@ declare namespace PartnerPlatformApplicationValidator {
|
|
|
20
21
|
}
|
|
21
22
|
type AddProxyPathParam = {
|
|
22
23
|
/**
|
|
23
|
-
* - Extension
|
|
24
|
+
* - Extension's unique identifier for which a
|
|
25
|
+
* proxy URL will be generated
|
|
24
26
|
*/
|
|
25
27
|
extensionId: string;
|
|
26
28
|
body: PartnerPlatformModel.AddProxyReq;
|
|
27
29
|
};
|
|
28
30
|
type RemoveProxyPathParam = {
|
|
29
31
|
/**
|
|
30
|
-
* - Extension
|
|
32
|
+
* - Extension ID for which proxy URL needs to be removed
|
|
31
33
|
*/
|
|
32
34
|
extensionId: string;
|
|
33
35
|
/**
|
|
@@ -4,13 +4,14 @@ const PartnerPlatformModel = require("./PartnerPlatformModel");
|
|
|
4
4
|
|
|
5
5
|
/**
|
|
6
6
|
* @typedef AddProxyPathParam
|
|
7
|
-
* @property {string} extensionId - Extension
|
|
7
|
+
* @property {string} extensionId - Extension's unique identifier for which a
|
|
8
|
+
* proxy URL will be generated
|
|
8
9
|
* @property {PartnerPlatformModel.AddProxyReq} body
|
|
9
10
|
*/
|
|
10
11
|
|
|
11
12
|
/**
|
|
12
13
|
* @typedef RemoveProxyPathParam
|
|
13
|
-
* @property {string} extensionId - Extension
|
|
14
|
+
* @property {string} extensionId - Extension ID for which proxy URL needs to be removed
|
|
14
15
|
* @property {string} attachedPath - Attached path slug
|
|
15
16
|
*/
|
|
16
17
|
|
|
@@ -1,9 +1,11 @@
|
|
|
1
1
|
export = PartnerPlatformModel;
|
|
2
2
|
/**
|
|
3
3
|
* @typedef AddProxyReq
|
|
4
|
-
* @property {string} [attached_path] -
|
|
5
|
-
*
|
|
6
|
-
*
|
|
4
|
+
* @property {string} [attached_path] - Attached path can be any slug that will
|
|
5
|
+
* be appended to the base URL to create a proxy endpoint, e.g.,
|
|
6
|
+
* /ext/{attached_path}. Note: attached_path should be unique for each
|
|
7
|
+
* extension within the same application.
|
|
8
|
+
* @property {string} [proxy_url] - External URL for which the proxy URL will be generated
|
|
7
9
|
*/
|
|
8
10
|
/**
|
|
9
11
|
* @typedef ExtensionProxyPathCreation
|
|
@@ -47,12 +49,14 @@ declare namespace PartnerPlatformModel {
|
|
|
47
49
|
declare function AddProxyReq(): AddProxyReq;
|
|
48
50
|
type AddProxyReq = {
|
|
49
51
|
/**
|
|
50
|
-
* -
|
|
52
|
+
* - Attached path can be any slug that will
|
|
53
|
+
* be appended to the base URL to create a proxy endpoint, e.g.,
|
|
54
|
+
* /ext/{attached_path}. Note: attached_path should be unique for each
|
|
55
|
+
* extension within the same application.
|
|
51
56
|
*/
|
|
52
57
|
attached_path?: string;
|
|
53
58
|
/**
|
|
54
|
-
* -
|
|
55
|
-
* will be generated
|
|
59
|
+
* - External URL for which the proxy URL will be generated
|
|
56
60
|
*/
|
|
57
61
|
proxy_url?: string;
|
|
58
62
|
};
|
|
@@ -2,9 +2,11 @@ const Joi = require("joi");
|
|
|
2
2
|
|
|
3
3
|
/**
|
|
4
4
|
* @typedef AddProxyReq
|
|
5
|
-
* @property {string} [attached_path] -
|
|
6
|
-
*
|
|
7
|
-
*
|
|
5
|
+
* @property {string} [attached_path] - Attached path can be any slug that will
|
|
6
|
+
* be appended to the base URL to create a proxy endpoint, e.g.,
|
|
7
|
+
* /ext/{attached_path}. Note: attached_path should be unique for each
|
|
8
|
+
* extension within the same application.
|
|
9
|
+
* @property {string} [proxy_url] - External URL for which the proxy URL will be generated
|
|
8
10
|
*/
|
|
9
11
|
|
|
10
12
|
/**
|
|
@@ -730,6 +730,7 @@ 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.
|
|
733
734
|
* @property {number} width - The width of the package material.
|
|
734
735
|
* @property {number} height - The height of the package material.
|
|
735
736
|
* @property {number} length - The length of the package material.
|
|
@@ -804,6 +805,7 @@ export = ServiceabilityPlatformModel;
|
|
|
804
805
|
* @property {boolean} [is_active] - Indicates if the package item is active.
|
|
805
806
|
* @property {string} [size] - The size of the package item.
|
|
806
807
|
* @property {number} [company_id] - The company ID associated with the package item.
|
|
808
|
+
* @property {number} [item_id] - The unique identifier for the package item.
|
|
807
809
|
* @property {number} [max_weight] - The maximum weight(grams) of the package item.
|
|
808
810
|
* @property {Object[]} [media] - Additional media associated with the package item.
|
|
809
811
|
* @property {number} [package_vol_weight] - The volumetric weight(grams) of the
|
|
@@ -4149,6 +4151,10 @@ type PackageMaterialResult = {
|
|
|
4149
4151
|
* - Unique identifier for the package material.
|
|
4150
4152
|
*/
|
|
4151
4153
|
id?: string;
|
|
4154
|
+
/**
|
|
4155
|
+
* - Unique identifier for the item.
|
|
4156
|
+
*/
|
|
4157
|
+
item_id?: number;
|
|
4152
4158
|
/**
|
|
4153
4159
|
* - The width of the package material.
|
|
4154
4160
|
*/
|
|
@@ -4347,6 +4353,10 @@ type PackageItem = {
|
|
|
4347
4353
|
* - The company ID associated with the package item.
|
|
4348
4354
|
*/
|
|
4349
4355
|
company_id?: number;
|
|
4356
|
+
/**
|
|
4357
|
+
* - The unique identifier for the package item.
|
|
4358
|
+
*/
|
|
4359
|
+
item_id?: number;
|
|
4350
4360
|
/**
|
|
4351
4361
|
* - The maximum weight(grams) of the package item.
|
|
4352
4362
|
*/
|
|
@@ -804,6 +804,7 @@ 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.
|
|
807
808
|
* @property {number} width - The width of the package material.
|
|
808
809
|
* @property {number} height - The height of the package material.
|
|
809
810
|
* @property {number} length - The length of the package material.
|
|
@@ -882,6 +883,7 @@ const Joi = require("joi");
|
|
|
882
883
|
* @property {boolean} [is_active] - Indicates if the package item is active.
|
|
883
884
|
* @property {string} [size] - The size of the package item.
|
|
884
885
|
* @property {number} [company_id] - The company ID associated with the package item.
|
|
886
|
+
* @property {number} [item_id] - The unique identifier for the package item.
|
|
885
887
|
* @property {number} [max_weight] - The maximum weight(grams) of the package item.
|
|
886
888
|
* @property {Object[]} [media] - Additional media associated with the package item.
|
|
887
889
|
* @property {number} [package_vol_weight] - The volumetric weight(grams) of the
|
|
@@ -3423,6 +3425,7 @@ class ServiceabilityPlatformModel {
|
|
|
3423
3425
|
company_id: Joi.number(),
|
|
3424
3426
|
name: Joi.string().allow("").required(),
|
|
3425
3427
|
id: Joi.string().allow(""),
|
|
3428
|
+
item_id: Joi.number(),
|
|
3426
3429
|
width: Joi.number().required(),
|
|
3427
3430
|
height: Joi.number().required(),
|
|
3428
3431
|
length: Joi.number().required(),
|
|
@@ -3502,6 +3505,7 @@ class ServiceabilityPlatformModel {
|
|
|
3502
3505
|
is_active: Joi.boolean(),
|
|
3503
3506
|
size: Joi.string().allow(""),
|
|
3504
3507
|
company_id: Joi.number(),
|
|
3508
|
+
item_id: Joi.number(),
|
|
3505
3509
|
max_weight: Joi.number(),
|
|
3506
3510
|
media: Joi.array().items(Joi.any()),
|
|
3507
3511
|
package_vol_weight: Joi.number(),
|