@gofynd/fdk-client-javascript 1.6.3 → 1.6.4
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/partner/Webhook/WebhookPartnerModel.d.ts +59 -1
- package/sdk/partner/Webhook/WebhookPartnerModel.js +34 -0
- package/sdk/platform/Order/OrderPlatformModel.d.ts +25 -1
- package/sdk/platform/Order/OrderPlatformModel.js +19 -0
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +63 -0
- package/sdk/platform/User/UserPlatformApplicationClient.js +464 -0
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +117 -1
- package/sdk/platform/User/UserPlatformApplicationValidator.js +85 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +218 -6
- package/sdk/platform/User/UserPlatformModel.js +151 -5
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +59 -1
- package/sdk/platform/Webhook/WebhookPlatformModel.js +34 -0
package/README.md
CHANGED
|
@@ -237,7 +237,7 @@ console.log("Active Theme: ", response.information.name);
|
|
|
237
237
|
The above code will log the curl command in the console
|
|
238
238
|
|
|
239
239
|
```bash
|
|
240
|
-
curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 1.6.
|
|
240
|
+
curl --request GET "https://api.fynd.com/service/application/theme/v1.0/applied-theme" --header 'authorization: Bearer <authorization-token>' --header 'x-fp-sdk-version: 1.6.4' --header 'x-fp-date: 20230222T115108Z' --header 'x-fp-signature: v1.1:1e3ab3b02b5bc626e3c32a37ee844266ade02bbcbaafc28fc7a0e46a76a7a1a8'
|
|
241
241
|
Active Theme: Emerge
|
|
242
242
|
```
|
|
243
243
|
|
package/package.json
CHANGED
|
@@ -44,10 +44,31 @@ export = WebhookPartnerModel;
|
|
|
44
44
|
* the subscriber.
|
|
45
45
|
* @property {number} [subscriber_id] - The identifier for the subscriber
|
|
46
46
|
* involved in the mapping.
|
|
47
|
+
* @property {FilterSchema} [filters]
|
|
48
|
+
* @property {Object} [reducer] - The reducer property allows users to customize
|
|
49
|
+
* the JSON structure of the webhook payload using JSONPath queries. They can
|
|
50
|
+
* also create new properties by mapping existing ones. Note that it overrides
|
|
51
|
+
* the entire JSON structure of the webhook payload sent via the webhook. See
|
|
52
|
+
* the partner documentation's filter and reducer section for details.
|
|
47
53
|
* @property {BroadcasterConfig} [broadcaster_config]
|
|
48
54
|
* @property {string} [created_on] - The timestamp indicating when the
|
|
49
55
|
* subscriber event mapping was created.
|
|
50
56
|
*/
|
|
57
|
+
/**
|
|
58
|
+
* @typedef FilterSchema
|
|
59
|
+
* @property {string} [query] - JSONPath expression that specifies the property
|
|
60
|
+
* in the webhook payload to filter on. This enables targeting specific data
|
|
61
|
+
* within the payload.
|
|
62
|
+
* @property {string} [condition] - JavaScript function used to evaluate the
|
|
63
|
+
* specified property in the webhook payload against a condition. This
|
|
64
|
+
* function determines whether the filter passes based on its return value.
|
|
65
|
+
* @property {string} [logic] - Logical operator used to combine multiple
|
|
66
|
+
* conditions in the `conditions` array. Supported values are `AND` and `OR`.
|
|
67
|
+
* @property {Object[]} [conditions] - An array of filter objects to be
|
|
68
|
+
* evaluated using the specified logical operator. This array will contain
|
|
69
|
+
* more filters including a combination of single condition mode and logical
|
|
70
|
+
* group mode filters.
|
|
71
|
+
*/
|
|
51
72
|
/**
|
|
52
73
|
* @typedef EventConfigDetails
|
|
53
74
|
* @property {number} [id] - The unique identifier for the event configuration.
|
|
@@ -300,7 +321,7 @@ export = WebhookPartnerModel;
|
|
|
300
321
|
declare class WebhookPartnerModel {
|
|
301
322
|
}
|
|
302
323
|
declare namespace WebhookPartnerModel {
|
|
303
|
-
export { SubscriberUpdate, SubscriberUpdateResult, Association, AuthMeta, BroadcasterConfig, SubscriberEventMapping, EventConfigDetails, SubscriberConfigDetails, InvalidEventsPayload, InvalidEventsResult, HistoryFilters, Url, CdnObject, UploadServiceObject, HistoryAssociation, HistoryItems, HistoryResult, HistoryPayload, CancelDownloadResult, FilterReportResult, DeliveryTsResult, DeliveryTsSchema, DeliveryDetailsPayload, EventDeliveryDetailSchema, DeliveryDetailsResult, EventProcessReportObject, Page, DeliveryEventLevelSchema, ResponseTimeTs, AvgResponseTime, DeliverySummaryResult, DeliverySummarySchema, ItemSchema };
|
|
324
|
+
export { SubscriberUpdate, SubscriberUpdateResult, Association, AuthMeta, BroadcasterConfig, SubscriberEventMapping, FilterSchema, EventConfigDetails, SubscriberConfigDetails, InvalidEventsPayload, InvalidEventsResult, HistoryFilters, Url, CdnObject, UploadServiceObject, HistoryAssociation, HistoryItems, HistoryResult, HistoryPayload, CancelDownloadResult, FilterReportResult, DeliveryTsResult, DeliveryTsSchema, DeliveryDetailsPayload, EventDeliveryDetailSchema, DeliveryDetailsResult, EventProcessReportObject, Page, DeliveryEventLevelSchema, ResponseTimeTs, AvgResponseTime, DeliverySummaryResult, DeliverySummarySchema, ItemSchema };
|
|
304
325
|
}
|
|
305
326
|
/** @returns {SubscriberUpdate} */
|
|
306
327
|
declare function SubscriberUpdate(): SubscriberUpdate;
|
|
@@ -404,6 +425,15 @@ type SubscriberEventMapping = {
|
|
|
404
425
|
* involved in the mapping.
|
|
405
426
|
*/
|
|
406
427
|
subscriber_id?: number;
|
|
428
|
+
filters?: FilterSchema;
|
|
429
|
+
/**
|
|
430
|
+
* - The reducer property allows users to customize
|
|
431
|
+
* the JSON structure of the webhook payload using JSONPath queries. They can
|
|
432
|
+
* also create new properties by mapping existing ones. Note that it overrides
|
|
433
|
+
* the entire JSON structure of the webhook payload sent via the webhook. See
|
|
434
|
+
* the partner documentation's filter and reducer section for details.
|
|
435
|
+
*/
|
|
436
|
+
reducer?: any;
|
|
407
437
|
broadcaster_config?: BroadcasterConfig;
|
|
408
438
|
/**
|
|
409
439
|
* - The timestamp indicating when the
|
|
@@ -411,6 +441,34 @@ type SubscriberEventMapping = {
|
|
|
411
441
|
*/
|
|
412
442
|
created_on?: string;
|
|
413
443
|
};
|
|
444
|
+
/** @returns {FilterSchema} */
|
|
445
|
+
declare function FilterSchema(): FilterSchema;
|
|
446
|
+
type FilterSchema = {
|
|
447
|
+
/**
|
|
448
|
+
* - JSONPath expression that specifies the property
|
|
449
|
+
* in the webhook payload to filter on. This enables targeting specific data
|
|
450
|
+
* within the payload.
|
|
451
|
+
*/
|
|
452
|
+
query?: string;
|
|
453
|
+
/**
|
|
454
|
+
* - JavaScript function used to evaluate the
|
|
455
|
+
* specified property in the webhook payload against a condition. This
|
|
456
|
+
* function determines whether the filter passes based on its return value.
|
|
457
|
+
*/
|
|
458
|
+
condition?: string;
|
|
459
|
+
/**
|
|
460
|
+
* - Logical operator used to combine multiple
|
|
461
|
+
* conditions in the `conditions` array. Supported values are `AND` and `OR`.
|
|
462
|
+
*/
|
|
463
|
+
logic?: string;
|
|
464
|
+
/**
|
|
465
|
+
* - An array of filter objects to be
|
|
466
|
+
* evaluated using the specified logical operator. This array will contain
|
|
467
|
+
* more filters including a combination of single condition mode and logical
|
|
468
|
+
* group mode filters.
|
|
469
|
+
*/
|
|
470
|
+
conditions?: any[];
|
|
471
|
+
};
|
|
414
472
|
/** @returns {EventConfigDetails} */
|
|
415
473
|
declare function EventConfigDetails(): EventConfigDetails;
|
|
416
474
|
type EventConfigDetails = {
|
|
@@ -50,11 +50,33 @@ const Joi = require("joi");
|
|
|
50
50
|
* the subscriber.
|
|
51
51
|
* @property {number} [subscriber_id] - The identifier for the subscriber
|
|
52
52
|
* involved in the mapping.
|
|
53
|
+
* @property {FilterSchema} [filters]
|
|
54
|
+
* @property {Object} [reducer] - The reducer property allows users to customize
|
|
55
|
+
* the JSON structure of the webhook payload using JSONPath queries. They can
|
|
56
|
+
* also create new properties by mapping existing ones. Note that it overrides
|
|
57
|
+
* the entire JSON structure of the webhook payload sent via the webhook. See
|
|
58
|
+
* the partner documentation's filter and reducer section for details.
|
|
53
59
|
* @property {BroadcasterConfig} [broadcaster_config]
|
|
54
60
|
* @property {string} [created_on] - The timestamp indicating when the
|
|
55
61
|
* subscriber event mapping was created.
|
|
56
62
|
*/
|
|
57
63
|
|
|
64
|
+
/**
|
|
65
|
+
* @typedef FilterSchema
|
|
66
|
+
* @property {string} [query] - JSONPath expression that specifies the property
|
|
67
|
+
* in the webhook payload to filter on. This enables targeting specific data
|
|
68
|
+
* within the payload.
|
|
69
|
+
* @property {string} [condition] - JavaScript function used to evaluate the
|
|
70
|
+
* specified property in the webhook payload against a condition. This
|
|
71
|
+
* function determines whether the filter passes based on its return value.
|
|
72
|
+
* @property {string} [logic] - Logical operator used to combine multiple
|
|
73
|
+
* conditions in the `conditions` array. Supported values are `AND` and `OR`.
|
|
74
|
+
* @property {Object[]} [conditions] - An array of filter objects to be
|
|
75
|
+
* evaluated using the specified logical operator. This array will contain
|
|
76
|
+
* more filters including a combination of single condition mode and logical
|
|
77
|
+
* group mode filters.
|
|
78
|
+
*/
|
|
79
|
+
|
|
58
80
|
/**
|
|
59
81
|
* @typedef EventConfigDetails
|
|
60
82
|
* @property {number} [id] - The unique identifier for the event configuration.
|
|
@@ -382,11 +404,23 @@ class WebhookPartnerModel {
|
|
|
382
404
|
id: Joi.number(),
|
|
383
405
|
event_id: Joi.number(),
|
|
384
406
|
subscriber_id: Joi.number(),
|
|
407
|
+
filters: WebhookPartnerModel.FilterSchema(),
|
|
408
|
+
reducer: Joi.object().pattern(/\S/, Joi.any()).allow(null, ""),
|
|
385
409
|
broadcaster_config: WebhookPartnerModel.BroadcasterConfig(),
|
|
386
410
|
created_on: Joi.string().allow(""),
|
|
387
411
|
});
|
|
388
412
|
}
|
|
389
413
|
|
|
414
|
+
/** @returns {FilterSchema} */
|
|
415
|
+
static FilterSchema() {
|
|
416
|
+
return Joi.object({
|
|
417
|
+
query: Joi.string().allow(""),
|
|
418
|
+
condition: Joi.string().allow(""),
|
|
419
|
+
logic: Joi.string().allow(""),
|
|
420
|
+
conditions: Joi.array().items(Joi.object().pattern(/\S/, Joi.any())),
|
|
421
|
+
}).allow(null);
|
|
422
|
+
}
|
|
423
|
+
|
|
390
424
|
/** @returns {EventConfigDetails} */
|
|
391
425
|
static EventConfigDetails() {
|
|
392
426
|
return Joi.object({
|
|
@@ -276,6 +276,11 @@ export = OrderPlatformModel;
|
|
|
276
276
|
* the properties of any relevant entities.
|
|
277
277
|
* @property {OrderDataUpdates[]} [order]
|
|
278
278
|
*/
|
|
279
|
+
/**
|
|
280
|
+
* @typedef TransitionComments
|
|
281
|
+
* @property {string} title - Title for the transition message.
|
|
282
|
+
* @property {string} message - Message for the transition.
|
|
283
|
+
*/
|
|
279
284
|
/**
|
|
280
285
|
* @typedef ShipmentsRequestSchema
|
|
281
286
|
* @property {string} identifier - Unique identifier for the shipment.
|
|
@@ -283,6 +288,8 @@ export = OrderPlatformModel;
|
|
|
283
288
|
* @property {Products[]} [products] - A list of products or bags that need to
|
|
284
289
|
* be updated as part of the shipment status change.
|
|
285
290
|
* @property {DataUpdates} [data_updates]
|
|
291
|
+
* @property {TransitionComments[]} [transition_comments] - Comments or notes
|
|
292
|
+
* associated with the transition of shipment status.
|
|
286
293
|
*/
|
|
287
294
|
/**
|
|
288
295
|
* @typedef UpdatedAddressSchema
|
|
@@ -4914,7 +4921,7 @@ export = OrderPlatformModel;
|
|
|
4914
4921
|
declare class OrderPlatformModel {
|
|
4915
4922
|
}
|
|
4916
4923
|
declare namespace OrderPlatformModel {
|
|
4917
|
-
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, 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 };
|
|
4924
|
+
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 };
|
|
4918
4925
|
}
|
|
4919
4926
|
/** @returns {InvalidateShipmentCachePayload} */
|
|
4920
4927
|
declare function InvalidateShipmentCachePayload(): InvalidateShipmentCachePayload;
|
|
@@ -5508,6 +5515,18 @@ type DataUpdates = {
|
|
|
5508
5515
|
entities?: EntitiesDataUpdates[];
|
|
5509
5516
|
order?: OrderDataUpdates[];
|
|
5510
5517
|
};
|
|
5518
|
+
/** @returns {TransitionComments} */
|
|
5519
|
+
declare function TransitionComments(): TransitionComments;
|
|
5520
|
+
type TransitionComments = {
|
|
5521
|
+
/**
|
|
5522
|
+
* - Title for the transition message.
|
|
5523
|
+
*/
|
|
5524
|
+
title: string;
|
|
5525
|
+
/**
|
|
5526
|
+
* - Message for the transition.
|
|
5527
|
+
*/
|
|
5528
|
+
message: string;
|
|
5529
|
+
};
|
|
5511
5530
|
/** @returns {ShipmentsRequestSchema} */
|
|
5512
5531
|
declare function ShipmentsRequestSchema(): ShipmentsRequestSchema;
|
|
5513
5532
|
type ShipmentsRequestSchema = {
|
|
@@ -5522,6 +5541,11 @@ type ShipmentsRequestSchema = {
|
|
|
5522
5541
|
*/
|
|
5523
5542
|
products?: Products[];
|
|
5524
5543
|
data_updates?: DataUpdates;
|
|
5544
|
+
/**
|
|
5545
|
+
* - Comments or notes
|
|
5546
|
+
* associated with the transition of shipment status.
|
|
5547
|
+
*/
|
|
5548
|
+
transition_comments?: TransitionComments[];
|
|
5525
5549
|
};
|
|
5526
5550
|
/** @returns {UpdatedAddressSchema} */
|
|
5527
5551
|
declare function UpdatedAddressSchema(): UpdatedAddressSchema;
|
|
@@ -307,6 +307,12 @@ const Joi = require("joi");
|
|
|
307
307
|
* @property {OrderDataUpdates[]} [order]
|
|
308
308
|
*/
|
|
309
309
|
|
|
310
|
+
/**
|
|
311
|
+
* @typedef TransitionComments
|
|
312
|
+
* @property {string} title - Title for the transition message.
|
|
313
|
+
* @property {string} message - Message for the transition.
|
|
314
|
+
*/
|
|
315
|
+
|
|
310
316
|
/**
|
|
311
317
|
* @typedef ShipmentsRequestSchema
|
|
312
318
|
* @property {string} identifier - Unique identifier for the shipment.
|
|
@@ -314,6 +320,8 @@ const Joi = require("joi");
|
|
|
314
320
|
* @property {Products[]} [products] - A list of products or bags that need to
|
|
315
321
|
* be updated as part of the shipment status change.
|
|
316
322
|
* @property {DataUpdates} [data_updates]
|
|
323
|
+
* @property {TransitionComments[]} [transition_comments] - Comments or notes
|
|
324
|
+
* associated with the transition of shipment status.
|
|
317
325
|
*/
|
|
318
326
|
|
|
319
327
|
/**
|
|
@@ -5574,6 +5582,14 @@ class OrderPlatformModel {
|
|
|
5574
5582
|
});
|
|
5575
5583
|
}
|
|
5576
5584
|
|
|
5585
|
+
/** @returns {TransitionComments} */
|
|
5586
|
+
static TransitionComments() {
|
|
5587
|
+
return Joi.object({
|
|
5588
|
+
title: Joi.string().allow("").required(),
|
|
5589
|
+
message: Joi.string().allow("").required(),
|
|
5590
|
+
});
|
|
5591
|
+
}
|
|
5592
|
+
|
|
5577
5593
|
/** @returns {ShipmentsRequestSchema} */
|
|
5578
5594
|
static ShipmentsRequestSchema() {
|
|
5579
5595
|
return Joi.object({
|
|
@@ -5581,6 +5597,9 @@ class OrderPlatformModel {
|
|
|
5581
5597
|
reasons: OrderPlatformModel.ReasonsData(),
|
|
5582
5598
|
products: Joi.array().items(OrderPlatformModel.Products()),
|
|
5583
5599
|
data_updates: OrderPlatformModel.DataUpdates(),
|
|
5600
|
+
transition_comments: Joi.array().items(
|
|
5601
|
+
OrderPlatformModel.TransitionComments()
|
|
5602
|
+
),
|
|
5584
5603
|
});
|
|
5585
5604
|
}
|
|
5586
5605
|
|
|
@@ -23,6 +23,30 @@ declare class User {
|
|
|
23
23
|
* @description: Manage user access by blocking or unblocking their accounts, restricting login for blocked accounts and allowing login for unblocked accounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/blockOrUnblockUsers/).
|
|
24
24
|
*/
|
|
25
25
|
blockOrUnblockUsers({ body, requestHeaders }?: UserPlatformApplicationValidator.BlockOrUnblockUsersParam, { responseHeaders }?: object): Promise<UserPlatformModel.BlockUserSuccess>;
|
|
26
|
+
/**
|
|
27
|
+
* @param {UserPlatformApplicationValidator.BulkImportStoreFrontUsersParam} arg
|
|
28
|
+
* - Arg object
|
|
29
|
+
*
|
|
30
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
31
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
32
|
+
* @returns {Promise<UserPlatformModel.BulkActionModel>} - Success response
|
|
33
|
+
* @name bulkImportStoreFrontUsers
|
|
34
|
+
* @summary: Bulk import storefront customers using CSV and XLSX files.
|
|
35
|
+
* @description: The API allows bulk import of storefront customers using CSV or XLSX files. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/bulkImportStoreFrontUsers/).
|
|
36
|
+
*/
|
|
37
|
+
bulkImportStoreFrontUsers({ body, requestHeaders }?: UserPlatformApplicationValidator.BulkImportStoreFrontUsersParam, { responseHeaders }?: object): Promise<UserPlatformModel.BulkActionModel>;
|
|
38
|
+
/**
|
|
39
|
+
* @param {UserPlatformApplicationValidator.CreateBulkExportUsersParam} arg
|
|
40
|
+
* - Arg object
|
|
41
|
+
*
|
|
42
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
43
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
44
|
+
* @returns {Promise<UserPlatformModel.BulkActionModel>} - Success response
|
|
45
|
+
* @name createBulkExportUsers
|
|
46
|
+
* @summary: Bulk export storefront customers using CSV and XLSX files.
|
|
47
|
+
* @description: This API allows bulk export of storefront users by requesting files in CSV or XLSX format. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/createBulkExportUsers/).
|
|
48
|
+
*/
|
|
49
|
+
createBulkExportUsers({ body, requestHeaders }?: UserPlatformApplicationValidator.CreateBulkExportUsersParam, { responseHeaders }?: object): Promise<UserPlatformModel.BulkActionModel>;
|
|
26
50
|
/**
|
|
27
51
|
* @param {UserPlatformApplicationValidator.CreateUserParam} arg - Arg object
|
|
28
52
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -123,6 +147,34 @@ declare class User {
|
|
|
123
147
|
* @description: Retrieve a list of currently active user sessions. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getActiveSessions/).
|
|
124
148
|
*/
|
|
125
149
|
getActiveSessions({ id, requestHeaders }?: UserPlatformApplicationValidator.GetActiveSessionsParam, { responseHeaders }?: object): Promise<UserPlatformModel.SessionListResponseSchema>;
|
|
150
|
+
/**
|
|
151
|
+
* @param {UserPlatformApplicationValidator.GetBulkExportUsersListParam} arg
|
|
152
|
+
* - Arg object
|
|
153
|
+
*
|
|
154
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
155
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
156
|
+
* @returns {Promise<UserPlatformModel.BulkActionPaginationSchema>} - Success response
|
|
157
|
+
* @name getBulkExportUsersList
|
|
158
|
+
* @summary: Get Bulk User's Export Lists for a specific Application.
|
|
159
|
+
* @description: This API allows fetching the list of bulk user exports for a specific application and company.
|
|
160
|
+
* It supports pagination and filtering based on various parameters.
|
|
161
|
+
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getBulkExportUsersList/).
|
|
162
|
+
*/
|
|
163
|
+
getBulkExportUsersList({ pageNo, pageSize, fileFormat, search, startDate, endDate, status, requestHeaders, }?: UserPlatformApplicationValidator.GetBulkExportUsersListParam, { responseHeaders }?: object): Promise<UserPlatformModel.BulkActionPaginationSchema>;
|
|
164
|
+
/**
|
|
165
|
+
* @param {UserPlatformApplicationValidator.GetBulkImportUsersListParam} arg
|
|
166
|
+
* - Arg object
|
|
167
|
+
*
|
|
168
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
169
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
170
|
+
* @returns {Promise<UserPlatformModel.BulkActionPaginationSchema>} - Success response
|
|
171
|
+
* @name getBulkImportUsersList
|
|
172
|
+
* @summary: Get Bulk User's Import Lists for a specific Application.
|
|
173
|
+
* @description: This API allows fetching the list of bulk user imports for a specific application and company.
|
|
174
|
+
* It supports pagination and filtering based on various parameters.
|
|
175
|
+
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getBulkImportUsersList/).
|
|
176
|
+
*/
|
|
177
|
+
getBulkImportUsersList({ pageNo, pageSize, search, startDate, endDate, status, fileFormat, requestHeaders, }?: UserPlatformApplicationValidator.GetBulkImportUsersListParam, { responseHeaders }?: object): Promise<UserPlatformModel.BulkActionPaginationSchema>;
|
|
126
178
|
/**
|
|
127
179
|
* @param {UserPlatformApplicationValidator.GetCustomersParam} arg - Arg object
|
|
128
180
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
@@ -222,6 +274,17 @@ declare class User {
|
|
|
222
274
|
* @description: Retrieve a list of user groups. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUserGroups/).
|
|
223
275
|
*/
|
|
224
276
|
getUserGroups({ pageNo, pageSize, name, type, status, groupUid, requestHeaders }?: UserPlatformApplicationValidator.GetUserGroupsParam, { responseHeaders }?: object): Promise<UserPlatformModel.UserGroupListResponseSchema>;
|
|
277
|
+
/**
|
|
278
|
+
* @param {UserPlatformApplicationValidator.GetUsersJobByJobIdParam} arg - Arg object
|
|
279
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
280
|
+
* @param {import("../PlatformAPIClient").Options} - Options
|
|
281
|
+
* @returns {Promise<UserPlatformModel.BulkActionModel>} - Success response
|
|
282
|
+
* @name getUsersJobByJobId
|
|
283
|
+
* @summary: Retrieve Job Details by Job ID for a Specific Application, Including Both Import and Export Jobs.
|
|
284
|
+
* @description: This endpoint retrieves the details of a specific user's import and export related jobs associated with a given `job_id`, `application_id`, and `company_id`.
|
|
285
|
+
* - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/user/getUsersJobByJobId/).
|
|
286
|
+
*/
|
|
287
|
+
getUsersJobByJobId({ jobId, requestHeaders }?: UserPlatformApplicationValidator.GetUsersJobByJobIdParam, { responseHeaders }?: object): Promise<UserPlatformModel.BulkActionModel>;
|
|
225
288
|
/**
|
|
226
289
|
* @param {UserPlatformApplicationValidator.SearchUsersParam} arg - Arg object
|
|
227
290
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|