@gofynd/fdk-client-javascript 3.3.6 → 3.4.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/Catalog/CatalogApplicationClient.d.ts +6 -3
- package/sdk/application/Catalog/CatalogApplicationClient.js +24 -5
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +10 -0
- package/sdk/application/Logistic/LogisticApplicationClient.js +44 -0
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +4 -4
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +2 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +5 -0
- package/sdk/partner/Webhook/WebhookPartnerModel.js +2 -0
- package/sdk/platform/Cart/CartPlatformModel.d.ts +193 -1
- package/sdk/platform/Cart/CartPlatformModel.js +123 -0
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +4 -2
- package/sdk/platform/Catalog/CatalogPlatformClient.js +16 -3
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +33 -2
- package/sdk/platform/Catalog/CatalogPlatformModel.js +17 -2
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +5 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +2 -0
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +17 -1
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +15 -0
- package/sdk/platform/Order/OrderPlatformModel.d.ts +20 -1
- package/sdk/platform/Order/OrderPlatformModel.js +22 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +124 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +800 -33
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +139 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +125 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +2 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +8 -2
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +936 -62
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +591 -33
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +12 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +5 -0
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +36 -0
- package/sdk/platform/User/UserPlatformApplicationClient.js +251 -0
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +38 -1
- package/sdk/platform/User/UserPlatformApplicationValidator.js +42 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +430 -10
- package/sdk/platform/User/UserPlatformModel.js +276 -7
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +10 -0
- package/sdk/platform/Webhook/WebhookPlatformModel.js +4 -0
|
@@ -3431,6 +3431,7 @@ export = OrderPlatformModel;
|
|
|
3431
3431
|
* @property {Object} [logistics_meta] - An object storing detailed
|
|
3432
3432
|
* logistics-related information, including courier partner details and other
|
|
3433
3433
|
* relevant metadata.
|
|
3434
|
+
* @property {FulfillmentOption} [fulfillment_option]
|
|
3434
3435
|
*/
|
|
3435
3436
|
/**
|
|
3436
3437
|
* @typedef ShipmentInternalPlatformViewResponseSchema
|
|
@@ -4092,8 +4093,16 @@ export = OrderPlatformModel;
|
|
|
4092
4093
|
* 'lock' state prevents any shipment status transitions until a new label is
|
|
4093
4094
|
* downloaded.
|
|
4094
4095
|
*/
|
|
4096
|
+
/**
|
|
4097
|
+
* @typedef FulfillmentOption
|
|
4098
|
+
* @property {string} [name]
|
|
4099
|
+
* @property {string} [slug]
|
|
4100
|
+
* @property {string} [type]
|
|
4101
|
+
* @property {boolean} [is_default]
|
|
4102
|
+
*/
|
|
4095
4103
|
/**
|
|
4096
4104
|
* @typedef PlatformShipment
|
|
4105
|
+
* @property {FulfillmentOption} [fulfillment_option]
|
|
4097
4106
|
* @property {string} [picked_date] - Indicates the date and time when the
|
|
4098
4107
|
* shipment was physically picked up from the sender or the origin point by
|
|
4099
4108
|
* the delivery service. This timestamp is crucial for tracking the
|
|
@@ -4947,7 +4956,7 @@ export = OrderPlatformModel;
|
|
|
4947
4956
|
declare class OrderPlatformModel {
|
|
4948
4957
|
}
|
|
4949
4958
|
declare namespace OrderPlatformModel {
|
|
4950
|
-
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, 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, 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 };
|
|
4959
|
+
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, 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 };
|
|
4951
4960
|
}
|
|
4952
4961
|
/** @returns {InvalidateShipmentCachePayload} */
|
|
4953
4962
|
declare function InvalidateShipmentCachePayload(): InvalidateShipmentCachePayload;
|
|
@@ -12014,6 +12023,7 @@ type ShipmentItem = {
|
|
|
12014
12023
|
* relevant metadata.
|
|
12015
12024
|
*/
|
|
12016
12025
|
logistics_meta?: any;
|
|
12026
|
+
fulfillment_option?: FulfillmentOption;
|
|
12017
12027
|
};
|
|
12018
12028
|
/** @returns {ShipmentInternalPlatformViewResponseSchema} */
|
|
12019
12029
|
declare function ShipmentInternalPlatformViewResponseSchema(): ShipmentInternalPlatformViewResponseSchema;
|
|
@@ -13448,9 +13458,18 @@ type ShipmentLockDetails = {
|
|
|
13448
13458
|
*/
|
|
13449
13459
|
action_to_status?: any;
|
|
13450
13460
|
};
|
|
13461
|
+
/** @returns {FulfillmentOption} */
|
|
13462
|
+
declare function FulfillmentOption(): FulfillmentOption;
|
|
13463
|
+
type FulfillmentOption = {
|
|
13464
|
+
name?: string;
|
|
13465
|
+
slug?: string;
|
|
13466
|
+
type?: string;
|
|
13467
|
+
is_default?: boolean;
|
|
13468
|
+
};
|
|
13451
13469
|
/** @returns {PlatformShipment} */
|
|
13452
13470
|
declare function PlatformShipment(): PlatformShipment;
|
|
13453
13471
|
type PlatformShipment = {
|
|
13472
|
+
fulfillment_option?: FulfillmentOption;
|
|
13454
13473
|
/**
|
|
13455
13474
|
* - Indicates the date and time when the
|
|
13456
13475
|
* shipment was physically picked up from the sender or the origin point by
|
|
@@ -3703,6 +3703,7 @@ const Joi = require("joi");
|
|
|
3703
3703
|
* @property {Object} [logistics_meta] - An object storing detailed
|
|
3704
3704
|
* logistics-related information, including courier partner details and other
|
|
3705
3705
|
* relevant metadata.
|
|
3706
|
+
* @property {FulfillmentOption} [fulfillment_option]
|
|
3706
3707
|
*/
|
|
3707
3708
|
|
|
3708
3709
|
/**
|
|
@@ -4404,8 +4405,17 @@ const Joi = require("joi");
|
|
|
4404
4405
|
* downloaded.
|
|
4405
4406
|
*/
|
|
4406
4407
|
|
|
4408
|
+
/**
|
|
4409
|
+
* @typedef FulfillmentOption
|
|
4410
|
+
* @property {string} [name]
|
|
4411
|
+
* @property {string} [slug]
|
|
4412
|
+
* @property {string} [type]
|
|
4413
|
+
* @property {boolean} [is_default]
|
|
4414
|
+
*/
|
|
4415
|
+
|
|
4407
4416
|
/**
|
|
4408
4417
|
* @typedef PlatformShipment
|
|
4418
|
+
* @property {FulfillmentOption} [fulfillment_option]
|
|
4409
4419
|
* @property {string} [picked_date] - Indicates the date and time when the
|
|
4410
4420
|
* shipment was physically picked up from the sender or the origin point by
|
|
4411
4421
|
* the delivery service. This timestamp is crucial for tracking the
|
|
@@ -8523,6 +8533,7 @@ class OrderPlatformModel {
|
|
|
8523
8533
|
currency_info: OrderPlatformModel.CurrencyInfo(),
|
|
8524
8534
|
is_lapa_enabled: Joi.boolean(),
|
|
8525
8535
|
logistics_meta: Joi.object().pattern(/\S/, Joi.any()),
|
|
8536
|
+
fulfillment_option: OrderPlatformModel.FulfillmentOption(),
|
|
8526
8537
|
});
|
|
8527
8538
|
}
|
|
8528
8539
|
|
|
@@ -9065,9 +9076,20 @@ class OrderPlatformModel {
|
|
|
9065
9076
|
});
|
|
9066
9077
|
}
|
|
9067
9078
|
|
|
9079
|
+
/** @returns {FulfillmentOption} */
|
|
9080
|
+
static FulfillmentOption() {
|
|
9081
|
+
return Joi.object({
|
|
9082
|
+
name: Joi.string().allow(""),
|
|
9083
|
+
slug: Joi.string().allow(""),
|
|
9084
|
+
type: Joi.string().allow(""),
|
|
9085
|
+
is_default: Joi.boolean(),
|
|
9086
|
+
});
|
|
9087
|
+
}
|
|
9088
|
+
|
|
9068
9089
|
/** @returns {PlatformShipment} */
|
|
9069
9090
|
static PlatformShipment() {
|
|
9070
9091
|
return Joi.object({
|
|
9092
|
+
fulfillment_option: OrderPlatformModel.FulfillmentOption(),
|
|
9071
9093
|
picked_date: Joi.string().allow("").allow(null),
|
|
9072
9094
|
tracking_list: Joi.array().items(OrderPlatformModel.TrackingList()),
|
|
9073
9095
|
invoice: OrderPlatformModel.InvoiceInfo(),
|
|
@@ -42,6 +42,19 @@ declare class Serviceability {
|
|
|
42
42
|
* @description: Creates a rule within the delivery configuration. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createCourierPartnerRule/).
|
|
43
43
|
*/
|
|
44
44
|
createCourierPartnerRule({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateCourierPartnerRuleParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.CourierPartnerRuleResult>;
|
|
45
|
+
/**
|
|
46
|
+
* @param {ServiceabilityPlatformApplicationValidator.CreateFulfillmentOptionParam} arg
|
|
47
|
+
* - Arg object
|
|
48
|
+
*
|
|
49
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
50
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
51
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOption>} -
|
|
52
|
+
* Success response
|
|
53
|
+
* @name createFulfillmentOption
|
|
54
|
+
* @summary: Create a new fulfillment option
|
|
55
|
+
* @description: Creates a new fulfillment option for the specified company and application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createFulfillmentOption/).
|
|
56
|
+
*/
|
|
57
|
+
createFulfillmentOption({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateFulfillmentOptionParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.FulfillmentOption>;
|
|
45
58
|
/**
|
|
46
59
|
* @param {ServiceabilityPlatformApplicationValidator.CreateGeoAreaParam} arg
|
|
47
60
|
* - Arg object
|
|
@@ -94,6 +107,20 @@ declare class Serviceability {
|
|
|
94
107
|
* @description: Creates a delivery zone. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/createZone/).
|
|
95
108
|
*/
|
|
96
109
|
createZone({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.CreateZoneParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ZoneSchema>;
|
|
110
|
+
/**
|
|
111
|
+
* @param {ServiceabilityPlatformApplicationValidator.DeleteFulfillmentOptionsParam} arg
|
|
112
|
+
* - Arg object
|
|
113
|
+
*
|
|
114
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
115
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
116
|
+
* @returns {Promise<ServiceabilityPlatformModel.OperationResponseSchema>}
|
|
117
|
+
* - Success response
|
|
118
|
+
*
|
|
119
|
+
* @name deleteFulfillmentOptions
|
|
120
|
+
* @summary: Delete fulfillment options
|
|
121
|
+
* @description: Deletes fulfillment options for provided slug. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/deleteFulfillmentOptions/).
|
|
122
|
+
*/
|
|
123
|
+
deleteFulfillmentOptions({ slug, requestHeaders }?: ServiceabilityPlatformApplicationValidator.DeleteFulfillmentOptionsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.OperationResponseSchema>;
|
|
97
124
|
/**
|
|
98
125
|
* @param {ServiceabilityPlatformApplicationValidator.DeleteZoneParam} arg
|
|
99
126
|
* - Arg object
|
|
@@ -160,6 +187,20 @@ declare class Serviceability {
|
|
|
160
187
|
* @description: Get specific zone which is exported at the application level. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getBulkExport/).
|
|
161
188
|
*/
|
|
162
189
|
getBulkExport({ batchId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetBulkExportParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.GetZoneBulkExport>;
|
|
190
|
+
/**
|
|
191
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetBulkFulfillmentValidationStatusParam} arg
|
|
192
|
+
* - Arg object
|
|
193
|
+
*
|
|
194
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
195
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
196
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOptionBulkValidate>}
|
|
197
|
+
* - Success response
|
|
198
|
+
*
|
|
199
|
+
* @name getBulkFulfillmentValidationStatus
|
|
200
|
+
* @summary: Validate bulk fulfillment options.
|
|
201
|
+
* @description: Validates a bulk list of fulfillment options for an application before processing, ensuring correctness for stores or products. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getBulkFulfillmentValidationStatus/).
|
|
202
|
+
*/
|
|
203
|
+
getBulkFulfillmentValidationStatus({ bulkId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetBulkFulfillmentValidationStatusParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.FulfillmentOptionBulkValidate>;
|
|
163
204
|
/**
|
|
164
205
|
* @param {ServiceabilityPlatformApplicationValidator.GetBulkGeoAreaParam} arg
|
|
165
206
|
* - Arg object
|
|
@@ -215,6 +256,47 @@ declare class Serviceability {
|
|
|
215
256
|
* @description: Get all the serviceable courier partners of a destination and the shipments. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getCourierPartners/).
|
|
216
257
|
*/
|
|
217
258
|
getCourierPartners({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetCourierPartnersParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ShipmentCourierPartnerResult>;
|
|
259
|
+
/**
|
|
260
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetFulfillmentOptionProductsParam} arg
|
|
261
|
+
* - Arg object
|
|
262
|
+
*
|
|
263
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
264
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
265
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOptionProducts>}
|
|
266
|
+
* - Success response
|
|
267
|
+
*
|
|
268
|
+
* @name getFulfillmentOptionProducts
|
|
269
|
+
* @summary: Get products for a specific fulfillment option.
|
|
270
|
+
* @description: Retrieves products available for a specific fulfillment option in an application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getFulfillmentOptionProducts/).
|
|
271
|
+
*/
|
|
272
|
+
getFulfillmentOptionProducts({ slug, storeId, q, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetFulfillmentOptionProductsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.FulfillmentOptionProducts>;
|
|
273
|
+
/**
|
|
274
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetFulfillmentOptionStoresParam} arg
|
|
275
|
+
* - Arg object
|
|
276
|
+
*
|
|
277
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
278
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
279
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOptionStores>}
|
|
280
|
+
* - Success response
|
|
281
|
+
*
|
|
282
|
+
* @name getFulfillmentOptionStores
|
|
283
|
+
* @summary: Get stores for a specific fulfillment option.
|
|
284
|
+
* @description: Retrieves stores available for a specific fulfillment option in an application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getFulfillmentOptionStores/).
|
|
285
|
+
*/
|
|
286
|
+
getFulfillmentOptionStores({ slug, q, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetFulfillmentOptionStoresParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.FulfillmentOptionStores>;
|
|
287
|
+
/**
|
|
288
|
+
* @param {ServiceabilityPlatformApplicationValidator.GetFulfillmentOptionsParam} arg
|
|
289
|
+
* - Arg object
|
|
290
|
+
*
|
|
291
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
292
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
293
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOption>} -
|
|
294
|
+
* Success response
|
|
295
|
+
* @name getFulfillmentOptions
|
|
296
|
+
* @summary: Get fulfillment options
|
|
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
|
+
*/
|
|
299
|
+
getFulfillmentOptions({ slug, productId, storeId, requestHeaders }?: ServiceabilityPlatformApplicationValidator.GetFulfillmentOptionsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.FulfillmentOption>;
|
|
218
300
|
/**
|
|
219
301
|
* @param {ServiceabilityPlatformApplicationValidator.GetGeoAreaParam} arg
|
|
220
302
|
* - Arg object
|
|
@@ -300,7 +382,7 @@ declare class Serviceability {
|
|
|
300
382
|
* @summary: Get zones
|
|
301
383
|
* @description: Retrieves a list of delivery zones. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/getZones/).
|
|
302
384
|
*/
|
|
303
|
-
getZones({ stage, pageSize, pageNo, isActive, q, countryIsoCode, pincode, state, city, sector, requestHeaders, }?: ServiceabilityPlatformApplicationValidator.GetZonesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ListViewSchema>;
|
|
385
|
+
getZones({ stage, pageSize, pageNo, fulfillmentOptionSlug, isActive, q, countryIsoCode, pincode, state, city, sector, requestHeaders, }?: ServiceabilityPlatformApplicationValidator.GetZonesParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ListViewSchema>;
|
|
304
386
|
/**
|
|
305
387
|
* @param {ServiceabilityPlatformApplicationValidator.InsertApplicationConfigParam} arg
|
|
306
388
|
* - Arg object
|
|
@@ -328,6 +410,19 @@ declare class Serviceability {
|
|
|
328
410
|
* @description: Apply configs to application. Supports patching for buybox rule config and promise config. For reference, refer to examples - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/patchApplicationConfiguration/).
|
|
329
411
|
*/
|
|
330
412
|
patchApplicationConfiguration({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.PatchApplicationConfigurationParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ApplicationConfigPatchResult>;
|
|
413
|
+
/**
|
|
414
|
+
* @param {ServiceabilityPlatformApplicationValidator.PutFulfillmentOptionParam} arg
|
|
415
|
+
* - Arg object
|
|
416
|
+
*
|
|
417
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
418
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
419
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOption>} -
|
|
420
|
+
* Success response
|
|
421
|
+
* @name putFulfillmentOption
|
|
422
|
+
* @summary: Update an existing fulfillment option
|
|
423
|
+
* @description: Updates the details of an existing fulfillment option for the specified company and application - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/putFulfillmentOption/).
|
|
424
|
+
*/
|
|
425
|
+
putFulfillmentOption({ slug, body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.PutFulfillmentOptionParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.FulfillmentOption>;
|
|
331
426
|
/**
|
|
332
427
|
* @param {ServiceabilityPlatformApplicationValidator.UpdateApplicationConfigurationParam} arg
|
|
333
428
|
* - Arg object
|
|
@@ -501,6 +596,34 @@ declare class Serviceability {
|
|
|
501
596
|
* @description: Enable or Disable a Zone under that application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/updateZone/).
|
|
502
597
|
*/
|
|
503
598
|
updateZone({ zoneId, body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UpdateZoneParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.ZoneUpdateSuccessResult>;
|
|
599
|
+
/**
|
|
600
|
+
* @param {ServiceabilityPlatformApplicationValidator.UploadBulkFulfillmentOptionsParam} arg
|
|
601
|
+
* - Arg object
|
|
602
|
+
*
|
|
603
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
604
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
605
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOptionBulkData>}
|
|
606
|
+
* - Success response
|
|
607
|
+
*
|
|
608
|
+
* @name uploadBulkFulfillmentOptions
|
|
609
|
+
* @summary: Upload bulk fulfillment options.
|
|
610
|
+
* @description: Uploads a bulk list of fulfillment options for an application, allowing multiple fulfillment configurations to be processed at once. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/uploadBulkFulfillmentOptions/).
|
|
611
|
+
*/
|
|
612
|
+
uploadBulkFulfillmentOptions({ body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.UploadBulkFulfillmentOptionsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.FulfillmentOptionBulkData>;
|
|
613
|
+
/**
|
|
614
|
+
* @param {ServiceabilityPlatformApplicationValidator.ValidateBulkFulfillmentOptionsParam} arg
|
|
615
|
+
* - Arg object
|
|
616
|
+
*
|
|
617
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
618
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
619
|
+
* @returns {Promise<ServiceabilityPlatformModel.FulfillmentOptionBulkValidateData>}
|
|
620
|
+
* - Success response
|
|
621
|
+
*
|
|
622
|
+
* @name validateBulkFulfillmentOptions
|
|
623
|
+
* @summary: Validate bulk fulfillment options.
|
|
624
|
+
* @description: Validates a bulk list of fulfillment options for an application before processing, ensuring correctness for stores or products. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/platform/serviceability/validateBulkFulfillmentOptions/).
|
|
625
|
+
*/
|
|
626
|
+
validateBulkFulfillmentOptions({ type, body, requestHeaders }?: ServiceabilityPlatformApplicationValidator.ValidateBulkFulfillmentOptionsParam, { responseHeaders }?: object): Promise<ServiceabilityPlatformModel.FulfillmentOptionBulkValidateData>;
|
|
504
627
|
}
|
|
505
628
|
import ServiceabilityPlatformApplicationValidator = require("./ServiceabilityPlatformApplicationValidator");
|
|
506
629
|
import ServiceabilityPlatformModel = require("./ServiceabilityPlatformModel");
|