@gofynd/fdk-client-javascript 1.2.0 → 1.3.1-beta.1
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 +44 -7
- package/package.json +1 -2
- package/sdk/application/ApplicationAPIClient.d.ts +3 -3
- package/sdk/application/ApplicationAPIClient.js +6 -4
- package/sdk/application/ApplicationClient.d.ts +2 -3
- package/sdk/application/ApplicationClient.js +1 -45
- package/sdk/application/ApplicationConfig.d.ts +46 -6
- package/sdk/application/ApplicationConfig.js +15 -16
- package/sdk/application/Cart/CartApplicationClient.d.ts +61 -33
- package/sdk/application/Cart/CartApplicationClient.js +225 -134
- package/sdk/application/Cart/CartApplicationModel.d.ts +6 -4
- package/sdk/application/Cart/CartApplicationModel.js +6 -4
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +61 -30
- package/sdk/application/Catalog/CatalogApplicationClient.js +234 -146
- package/sdk/application/Catalog/CatalogApplicationModel.d.ts +115 -13
- package/sdk/application/Catalog/CatalogApplicationModel.js +77 -12
- package/sdk/application/Common/CommonApplicationClient.d.ts +5 -3
- package/sdk/application/Common/CommonApplicationClient.js +13 -11
- package/sdk/application/Common/CommonApplicationModel.d.ts +3 -83
- package/sdk/application/Common/CommonApplicationModel.js +2 -58
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +9 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +25 -13
- package/sdk/application/Communication/CommunicationApplicationModel.d.ts +1 -34
- package/sdk/application/Communication/CommunicationApplicationModel.js +0 -36
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +46 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +144 -68
- package/sdk/application/Configuration/ConfigurationApplicationModel.d.ts +1 -219
- package/sdk/application/Configuration/ConfigurationApplicationModel.js +0 -226
- package/sdk/application/Content/ContentApplicationClient.d.ts +49 -21
- package/sdk/application/Content/ContentApplicationClient.js +159 -80
- package/sdk/application/Content/ContentApplicationModel.d.ts +5 -622
- package/sdk/application/Content/ContentApplicationModel.js +11 -763
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +6 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +20 -14
- package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts +1 -152
- package/sdk/application/FileStorage/FileStorageApplicationModel.js +0 -180
- package/sdk/application/Lead/LeadApplicationClient.d.ts +14 -7
- package/sdk/application/Lead/LeadApplicationClient.js +50 -31
- package/sdk/application/Lead/LeadApplicationModel.d.ts +22 -741
- package/sdk/application/Lead/LeadApplicationModel.js +21 -481
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +11 -5
- package/sdk/application/Logistic/LogisticApplicationClient.js +41 -20
- package/sdk/application/Order/OrderApplicationClient.d.ts +24 -12
- package/sdk/application/Order/OrderApplicationClient.js +88 -56
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +91 -42
- package/sdk/application/Payment/PaymentApplicationClient.js +293 -194
- package/sdk/application/Payment/PaymentApplicationModel.d.ts +36 -36
- package/sdk/application/Payment/PaymentApplicationModel.js +36 -36
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +59 -32
- package/sdk/application/PosCart/PosCartApplicationClient.js +214 -130
- package/sdk/application/PosCart/PosCartApplicationModel.d.ts +2 -2
- package/sdk/application/PosCart/PosCartApplicationModel.js +2 -2
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +16 -7
- package/sdk/application/Rewards/RewardsApplicationClient.js +56 -29
- package/sdk/application/Share/ShareApplicationClient.d.ts +15 -7
- package/sdk/application/Share/ShareApplicationClient.js +51 -31
- package/sdk/application/Share/ShareApplicationModel.d.ts +1 -33
- package/sdk/application/Share/ShareApplicationModel.js +0 -38
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +9 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +35 -18
- package/sdk/application/Theme/ThemeApplicationModel.d.ts +982 -312
- package/sdk/application/Theme/ThemeApplicationModel.js +621 -284
- package/sdk/application/User/UserApplicationClient.d.ts +74 -35
- package/sdk/application/User/UserApplicationClient.js +252 -161
- package/sdk/application/User/UserApplicationModel.d.ts +3 -401
- package/sdk/application/User/UserApplicationModel.js +2 -490
- package/sdk/common/AxiosHelper.js +1 -2
- package/sdk/common/FDKError.d.ts +3 -0
- package/sdk/common/FDKError.js +8 -0
- package/sdk/common/utils.d.ts +3 -0
- package/sdk/common/utils.js +29 -0
- package/sdk/partner/PartnerAPIClient.d.ts +5 -4
- package/sdk/partner/PartnerAPIClient.js +7 -4
- package/sdk/partner/PartnerClient.d.ts +2 -0
- package/sdk/partner/PartnerClient.js +3 -0
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +299 -0
- package/sdk/partner/Theme/ThemePartnerClient.js +768 -0
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +1706 -0
- package/sdk/partner/Theme/ThemePartnerModel.js +1409 -0
- package/sdk/partner/Theme/ThemePartnerValidator.d.ts +22 -0
- package/sdk/partner/Theme/ThemePartnerValidator.js +157 -0
- package/sdk/partner/index.d.ts +3 -1
- package/sdk/partner/index.js +3 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +8 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +38 -16
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +1 -13
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +0 -12
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +10 -0
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +4 -0
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +59 -14
- package/sdk/platform/Billing/BillingPlatformClient.js +315 -64
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +56 -196
- package/sdk/platform/Billing/BillingPlatformModel.js +63 -217
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +23 -1
- package/sdk/platform/Billing/BillingPlatformValidator.js +31 -0
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +124 -63
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +431 -265
- package/sdk/platform/Cart/CartPlatformModel.d.ts +253 -53
- package/sdk/platform/Cart/CartPlatformModel.js +104 -54
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +120 -53
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +398 -247
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +155 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.js +561 -355
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +10 -12
- package/sdk/platform/Catalog/CatalogPlatformModel.js +10 -12
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +30 -0
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +13 -0
- package/sdk/platform/Common/CommonPlatformClient.d.ts +5 -3
- package/sdk/platform/Common/CommonPlatformClient.js +13 -11
- package/sdk/platform/Common/CommonPlatformModel.d.ts +39 -64
- package/sdk/platform/Common/CommonPlatformModel.js +23 -57
- package/sdk/platform/Common/CommonPlatformValidator.d.ts +5 -10
- package/sdk/platform/Common/CommonPlatformValidator.js +3 -4
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +370 -120
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +2328 -888
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +143 -24
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +179 -15
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +2 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +6 -5
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +386 -308
- package/sdk/platform/Communication/CommunicationPlatformModel.js +415 -355
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +38 -13
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +171 -57
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +53 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +54 -0
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +5 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +7 -0
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +96 -29
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +311 -126
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +5 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +7 -0
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +36 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +121 -86
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +13 -180
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +5 -113
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +162 -70
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +528 -309
- package/sdk/platform/Content/ContentPlatformModel.d.ts +9 -198
- package/sdk/platform/Content/ContentPlatformModel.js +8 -231
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +48 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +142 -48
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +40 -1
- package/sdk/platform/Discount/DiscountPlatformModel.js +27 -0
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +84 -18
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +486 -53
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +71 -7
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +81 -5
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +13 -18
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +58 -65
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +198 -71
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +212 -64
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +18 -10
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +11 -6
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +177 -40
- package/sdk/platform/Finance/FinancePlatformClient.js +1028 -132
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +670 -22
- package/sdk/platform/Finance/FinancePlatformModel.js +809 -23
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +111 -1
- package/sdk/platform/Finance/FinancePlatformValidator.js +134 -0
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +24 -12
- package/sdk/platform/Inventory/InventoryPlatformClient.js +94 -52
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +27 -13
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +101 -55
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +50 -39
- package/sdk/platform/Lead/LeadPlatformClient.js +171 -112
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +32 -390
- package/sdk/platform/Lead/LeadPlatformModel.js +31 -214
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +33 -33
- package/sdk/platform/Lead/LeadPlatformValidator.js +23 -23
- package/sdk/platform/OAuthClient.js +6 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +4 -2
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +12 -10
- package/sdk/platform/Order/OrderPlatformClient.d.ts +165 -71
- package/sdk/platform/Order/OrderPlatformClient.js +738 -205
- package/sdk/platform/Order/OrderPlatformModel.d.ts +261 -3
- package/sdk/platform/Order/OrderPlatformModel.js +225 -2
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +104 -3
- package/sdk/platform/Order/OrderPlatformValidator.js +85 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -22
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +12 -159
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -30
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.js +0 -26
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +1 -690
- package/sdk/platform/Partner/PartnerPlatformModel.js +0 -809
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +167 -32
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +793 -145
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +91 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +91 -0
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +68 -47
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +549 -7
- package/sdk/platform/Payment/PaymentPlatformModel.js +305 -6
- package/sdk/platform/PlatformAPIClient.d.ts +3 -3
- package/sdk/platform/PlatformAPIClient.js +2 -2
- package/sdk/platform/PlatformClient.d.ts +2 -2
- package/sdk/platform/PlatformClient.js +4 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +28 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +90 -53
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +1 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.js +0 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +62 -26
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +210 -93
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +20 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +23 -11
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +36 -18
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +142 -78
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +12 -3
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +14 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +10 -26
- package/sdk/platform/Share/SharePlatformApplicationClient.js +36 -67
- package/sdk/platform/Share/SharePlatformModel.d.ts +4 -4
- package/sdk/platform/Share/SharePlatformModel.js +4 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +127 -57
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +564 -189
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +63 -26
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +62 -22
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +37 -0
- package/sdk/platform/Theme/ThemePlatformClient.js +235 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +1167 -261
- package/sdk/platform/Theme/ThemePlatformModel.js +801 -244
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +32 -0
- package/sdk/platform/Theme/ThemePlatformValidator.js +38 -0
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +35 -17
- package/sdk/platform/User/UserPlatformApplicationClient.js +132 -73
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +7 -0
- package/sdk/platform/User/UserPlatformApplicationValidator.js +3 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +1 -738
- package/sdk/platform/User/UserPlatformModel.js +3 -899
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +120 -7
- package/sdk/platform/Webhook/WebhookPlatformClient.js +799 -41
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +476 -86
- package/sdk/platform/Webhook/WebhookPlatformModel.js +388 -89
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +90 -7
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +113 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +5 -3
- package/sdk/public/Configuration/ConfigurationPublicClient.js +13 -11
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +3 -106
- package/sdk/public/Configuration/ConfigurationPublicModel.js +2 -59
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +12 -6
- package/sdk/public/Inventory/InventoryPublicClient.js +42 -27
- package/sdk/public/Partner/PartnerPublicClient.d.ts +22 -0
- package/sdk/public/Partner/PartnerPublicClient.js +110 -0
- package/sdk/public/Partner/PartnerPublicModel.d.ts +240 -0
- package/sdk/public/Partner/PartnerPublicModel.js +280 -0
- package/sdk/public/Partner/PartnerPublicValidator.d.ts +18 -0
- package/sdk/public/Partner/PartnerPublicValidator.js +19 -0
- package/sdk/public/PublicAPIClient.d.ts +14 -1
- package/sdk/public/PublicAPIClient.js +7 -1
- package/sdk/public/PublicClient.d.ts +2 -0
- package/sdk/public/PublicClient.js +4 -0
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -2
- package/sdk/public/Webhook/WebhookPublicClient.js +15 -9
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +1 -191
- package/sdk/public/Webhook/WebhookPublicModel.js +0 -229
- package/sdk/public/index.d.ts +1 -0
- package/sdk/public/index.js +2 -0
- package/sdk/application/ApplicationModels.d.ts +0 -48
- package/sdk/application/ApplicationModels.js +0 -38
- package/sdk/platform/Partner/PartnerPlatformClient.d.ts +0 -106
- package/sdk/platform/Partner/PartnerPlatformClient.js +0 -878
- package/sdk/platform/Partner/PartnerPlatformValidator.d.ts +0 -208
- package/sdk/platform/Partner/PartnerPlatformValidator.js +0 -169
|
@@ -513,6 +513,30 @@ export = OrderPlatformModel;
|
|
|
513
513
|
* @typedef BulkActionTemplateResponse
|
|
514
514
|
* @property {BulkActionTemplate[]} [template_x_slug] - Allowed bulk action template slugs
|
|
515
515
|
*/
|
|
516
|
+
/**
|
|
517
|
+
* @typedef BulkReportsDownloadFailedResponse
|
|
518
|
+
* @property {string} [error]
|
|
519
|
+
* @property {boolean} [status]
|
|
520
|
+
*/
|
|
521
|
+
/**
|
|
522
|
+
* @typedef BulkReportsDownloadRequest
|
|
523
|
+
* @property {Object} [custom_filters_for_lane]
|
|
524
|
+
* @property {string} [custom_headers] - Download report with specific headers
|
|
525
|
+
* @property {string[]} [entities] - Download for specific enitites, entities
|
|
526
|
+
* can be bag, shipment or order_id, etc.
|
|
527
|
+
* @property {string} [filter_type]
|
|
528
|
+
* @property {string} [from_date]
|
|
529
|
+
* @property {boolean} [is_cross_company_enabled] - Download lanes for cross company.
|
|
530
|
+
* @property {string} [lane_type]
|
|
531
|
+
* @property {string} [report_type] - Type of report
|
|
532
|
+
* @property {string[]} [store_ids] - Download for specific store ids.
|
|
533
|
+
* @property {string} [to_date]
|
|
534
|
+
*/
|
|
535
|
+
/**
|
|
536
|
+
* @typedef BulkReportsDownloadResponse
|
|
537
|
+
* @property {string} [batch_id]
|
|
538
|
+
* @property {boolean} [success]
|
|
539
|
+
*/
|
|
516
540
|
/**
|
|
517
541
|
* @typedef BuyerDetails
|
|
518
542
|
* @property {string} address
|
|
@@ -568,6 +592,30 @@ export = OrderPlatformModel;
|
|
|
568
592
|
* @property {string[]} [emails]
|
|
569
593
|
* @property {PhoneDetails[]} [phone]
|
|
570
594
|
*/
|
|
595
|
+
/**
|
|
596
|
+
* @typedef CourierPartnerTrackingDetails
|
|
597
|
+
* @property {string} awb - AWB Number
|
|
598
|
+
* @property {string} [dp_location] - Current location of Courier partner
|
|
599
|
+
* @property {string} dp_name - Courier Partner name
|
|
600
|
+
* @property {string} dp_status - Status at Courier partner end
|
|
601
|
+
* @property {string} dp_status_updated_at - Date Time at which status was
|
|
602
|
+
* updated at Courier partner
|
|
603
|
+
* @property {string} [estimated_delivery_date] - Estimated delivery date
|
|
604
|
+
* received from Courier partner
|
|
605
|
+
* @property {number} [id] - Id of Tracking history
|
|
606
|
+
* @property {string} journey - Journey type of the shipment
|
|
607
|
+
* @property {Object} [meta] - Meta field to store Courier partner's meta data
|
|
608
|
+
* @property {string} operational_status - Operational status of OMS
|
|
609
|
+
* @property {string} [promised_delivery_date] - Promised delivery date received
|
|
610
|
+
* from Courier partner
|
|
611
|
+
* @property {string} [remark] - Remark from courier partner
|
|
612
|
+
* @property {string} shipment_id - Shipment ID
|
|
613
|
+
*/
|
|
614
|
+
/**
|
|
615
|
+
* @typedef CourierPartnerTrackingResponse
|
|
616
|
+
* @property {CourierPartnerTrackingDetails[]} [items]
|
|
617
|
+
* @property {PageDetails} [page]
|
|
618
|
+
*/
|
|
571
619
|
/**
|
|
572
620
|
* @typedef CreateChannelConfig
|
|
573
621
|
* @property {DpConfiguration} [dp_configuration]
|
|
@@ -728,6 +776,32 @@ export = OrderPlatformModel;
|
|
|
728
776
|
* @property {string} [user]
|
|
729
777
|
* @property {string} [username]
|
|
730
778
|
*/
|
|
779
|
+
/**
|
|
780
|
+
* @typedef EInvoiceResponseData
|
|
781
|
+
* @property {string} [ack_dt]
|
|
782
|
+
* @property {string} [ack_no]
|
|
783
|
+
* @property {string} [irn]
|
|
784
|
+
* @property {string} message
|
|
785
|
+
* @property {string} shipment_id
|
|
786
|
+
* @property {boolean} success
|
|
787
|
+
* @property {number} [timeout]
|
|
788
|
+
* @property {string} [timeout_unit]
|
|
789
|
+
*/
|
|
790
|
+
/**
|
|
791
|
+
* @typedef EInvoiceRetry
|
|
792
|
+
* @property {EInvoiceRetryShipmentData[]} [shipments_data]
|
|
793
|
+
*/
|
|
794
|
+
/**
|
|
795
|
+
* @typedef EInvoiceRetryResponse
|
|
796
|
+
* @property {string} [message]
|
|
797
|
+
* @property {EInvoiceResponseData[]} response_data
|
|
798
|
+
* @property {boolean} [success]
|
|
799
|
+
* @property {number} success_count
|
|
800
|
+
*/
|
|
801
|
+
/**
|
|
802
|
+
* @typedef EInvoiceRetryShipmentData
|
|
803
|
+
* @property {string} shipment_id
|
|
804
|
+
*/
|
|
731
805
|
/**
|
|
732
806
|
* @typedef Entities
|
|
733
807
|
* @property {string} [affiliate_bag_id] - Application/Affiliate Bag ID,
|
|
@@ -1038,7 +1112,7 @@ export = OrderPlatformModel;
|
|
|
1038
1112
|
/**
|
|
1039
1113
|
* @typedef LineItem
|
|
1040
1114
|
* @property {Charge[]} [charges]
|
|
1041
|
-
* @property {string} [
|
|
1115
|
+
* @property {string} [custom_message]
|
|
1042
1116
|
* @property {string} [external_line_id]
|
|
1043
1117
|
* @property {Object} [meta]
|
|
1044
1118
|
* @property {number} [quantity]
|
|
@@ -1270,6 +1344,15 @@ export = OrderPlatformModel;
|
|
|
1270
1344
|
* @property {number} [size]
|
|
1271
1345
|
* @property {string} type
|
|
1272
1346
|
*/
|
|
1347
|
+
/**
|
|
1348
|
+
* @typedef PageDetails
|
|
1349
|
+
* @property {number} [current] - Current page number
|
|
1350
|
+
* @property {boolean} [has_next] - If next page contains any result
|
|
1351
|
+
* @property {number} item_total - Total count of the results present in the
|
|
1352
|
+
* requested filter
|
|
1353
|
+
* @property {number} [size] - Page size
|
|
1354
|
+
* @property {string} [type] - Type of the page
|
|
1355
|
+
*/
|
|
1273
1356
|
/**
|
|
1274
1357
|
* @typedef PaymentInfo
|
|
1275
1358
|
* @property {PaymentMethod[]} [payment_methods]
|
|
@@ -1639,6 +1722,11 @@ export = OrderPlatformModel;
|
|
|
1639
1722
|
* @property {number} [time]
|
|
1640
1723
|
* @property {string} [unit]
|
|
1641
1724
|
*/
|
|
1725
|
+
/**
|
|
1726
|
+
* @typedef RoleBaseStateTransitionMapping
|
|
1727
|
+
* @property {string[]} [next_statuses]
|
|
1728
|
+
* @property {boolean} [success]
|
|
1729
|
+
*/
|
|
1642
1730
|
/**
|
|
1643
1731
|
* @typedef SendSmsPayload
|
|
1644
1732
|
* @property {number} bag_id - Bag_id for the activity history track
|
|
@@ -2122,6 +2210,7 @@ export = OrderPlatformModel;
|
|
|
2122
2210
|
* @typedef TaxInfo
|
|
2123
2211
|
* @property {string} [b2b_gstin_number]
|
|
2124
2212
|
* @property {string} [gstin]
|
|
2213
|
+
* @property {string} [pan_no]
|
|
2125
2214
|
*/
|
|
2126
2215
|
/**
|
|
2127
2216
|
* @typedef TrackingList
|
|
@@ -2254,7 +2343,7 @@ export = OrderPlatformModel;
|
|
|
2254
2343
|
declare class OrderPlatformModel {
|
|
2255
2344
|
}
|
|
2256
2345
|
declare namespace OrderPlatformModel {
|
|
2257
|
-
export { ActionInfo, AdvanceFilterInfo, Affiliate, AffiliateAppConfig, AffiliateAppConfigMeta, AffiliateBag, AffiliateBagDetails, AffiliateBagsDetails, AffiliateConfig, AffiliateDetails, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryOrderConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateMeta, AffiliateStoreIdMapping, AnnouncementResponse, AnnouncementsResponse, AppliedPromos, Article, ArticleDetails, AttachOrderUser, AttachOrderUserResponse, AttachUserInfo, AttachUserOtpData, Attributes, B2BPODetails, BagConfigs, BagDetailsPlatformResponse, BagGST, BagGSTDetails, BagMeta, BagPaymentMethods, BagReturnableCancelableStatus, BagReturnableCancelableStatus1, Bags, BagsPage, BagStateMapper, BagStateTransitionMap, BagStatusHistory, BagUnit, BaseResponse, BillingInfo, BillingStaffDetails, Brand, BulkActionTemplate, BulkActionTemplateResponse, BuyerDetails, BuyRules, Charge, CheckResponse, Click2CallResponse, CompanyDetails, ContactDetails, CreateChannelConfig, CreateChannelConfigData, CreateChannelConfigResponse, CreateChannelConifgErrorResponse, CreateChannelPaymentInfo, CreateOrderAPI, CreateOrderErrorReponse, CreateOrderPayload, CreateOrderResponse, CreditBalanceInfo, CurrentStatus, DataUpdates, Dates, DebugInfo, Dimension, Dimensions, DiscountRules, DispatchManifest, Document, DpConfiguration, DPDetailsData, EinvoiceInfo, EInvoicePortalDetails, Entities, EntitiesDataUpdates, EntitiesReasons, EntityReasonData, Error, ErrorDetail, ErrorResponse, FetchCreditBalanceRequestPayload, FetchCreditBalanceResponsePayload, FileResponse, FilterInfoOption, FiltersInfo, FiltersResponse, FinancialBreakup, Formatted, FulfillingStore, FyndOrderIdList, GeneratePosOrderReceiptResponse, GetActionsResponse, GetBagsPlatformResponse, GiftCard, GSTDetailsData, HistoryDict, HistoryMeta, HistoryReason, Identifier, InvalidateShipmentCacheNestedResponse, InvalidateShipmentCachePayload, InvalidateShipmentCacheResponse, InvoiceInfo, Item, ItemCriterias, LaneConfigResponse, LineItem, LocationDetails, LockData, MarketPlacePdf, Meta, OrderBagArticle, OrderBags, OrderBrandName, OrderConfig, OrderData, OrderDetails, OrderDetailsData, OrderDetailsResponse, OrderInfo, OrderingStoreDetails, OrderItemDataUpdates, OrderListingResponse, OrderMeta, OrderPriority, OrderStatus, OrderStatusData, OrderStatusResult, OrderUser, OriginalFilter, Page, PaymentInfo, PaymentMethod, PaymentMethods, PDFLinks, PhoneDetails, PlatformArticleAttributes, PlatformBreakupValues, PlatformChannel, PlatformDeliveryAddress, PlatformItem, PlatformOrderItems, PlatformOrderUpdate, PlatformShipment, PlatformShipmentReasonsResponse, PlatformShipmentTrack, PlatformTrack, PlatformUserDetails, PointBlankOtpData, PostActivityHistory, PostHistoryData, PostHistoryDict, PostHistoryFilters, PostShipmentHistory, Prices, ProcessingDates, Products, ProductsDataUpdates, ProductsDataUpdatesFilters, ProductsReasons, ProductsReasonsData, ProductsReasonsFilters, QuestionSet, Reason, ReasonsData, RefundModeConfigRequestPayload, RefundModeConfigResponsePayload, RefundModeInfo, RefundOption, ReplacementDetails, ResponseDetail, ReturnConfig, ReturnConfig1, SendSmsPayload, SendUserMobileOTP, SendUserMobileOtpResponse, Shipment, ShipmentConfig, ShipmentData, ShipmentDetail, ShipmentDetails, ShipmentHistoryResponse, ShipmentInfoResponse, ShipmentInternalPlatformViewResponse, ShipmentItem, ShipmentItemFulFillingStore, ShipmentItemMeta, ShipmentListingBrand, ShipmentListingChannel, ShipmentMeta, ShipmentPayments, ShipmentReasonsResponse, ShipmentResponseReasons, ShipmentsRequest, ShipmentsResponse, ShipmentStatus, ShipmentStatusData, ShipmentTags, ShipmentTimeStamp, ShippingInfo, SmsDataPayload, StatuesRequest, StatuesResponse, Store, StoreAddress, StoreDocuments, StoreEinvoice, StoreEwaybill, StoreGstCredentials, StoreMeta, StoreReassign, StoreReassignResponse, SubLane, SuccessResponse, SuperLane, Tax, TaxDetails, TaxInfo, TrackingList, TransactionData, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponse, UpdateShipmentLockPayload, UpdateShipmentLockResponse, UpdateShipmentStatusRequest, UpdateShipmentStatusResponseBody, UploadConsent, URL, UserData, UserDataInfo, UserDetailsData, VerifyMobileOTP, VerifyOtpData, VerifyOtpResponse, VerifyOtpResponseData, Weight };
|
|
2346
|
+
export { ActionInfo, AdvanceFilterInfo, Affiliate, AffiliateAppConfig, AffiliateAppConfigMeta, AffiliateBag, AffiliateBagDetails, AffiliateBagsDetails, AffiliateConfig, AffiliateDetails, AffiliateInventoryArticleAssignmentConfig, AffiliateInventoryConfig, AffiliateInventoryLogisticsConfig, AffiliateInventoryOrderConfig, AffiliateInventoryPaymentConfig, AffiliateInventoryStoreConfig, AffiliateMeta, AffiliateStoreIdMapping, AnnouncementResponse, AnnouncementsResponse, AppliedPromos, Article, ArticleDetails, AttachOrderUser, AttachOrderUserResponse, AttachUserInfo, AttachUserOtpData, Attributes, B2BPODetails, BagConfigs, BagDetailsPlatformResponse, BagGST, BagGSTDetails, BagMeta, BagPaymentMethods, BagReturnableCancelableStatus, BagReturnableCancelableStatus1, Bags, BagsPage, BagStateMapper, BagStateTransitionMap, BagStatusHistory, BagUnit, BaseResponse, BillingInfo, BillingStaffDetails, Brand, BulkActionTemplate, BulkActionTemplateResponse, BulkReportsDownloadFailedResponse, BulkReportsDownloadRequest, BulkReportsDownloadResponse, BuyerDetails, BuyRules, Charge, CheckResponse, Click2CallResponse, CompanyDetails, ContactDetails, CourierPartnerTrackingDetails, CourierPartnerTrackingResponse, CreateChannelConfig, CreateChannelConfigData, CreateChannelConfigResponse, CreateChannelConifgErrorResponse, CreateChannelPaymentInfo, CreateOrderAPI, CreateOrderErrorReponse, CreateOrderPayload, CreateOrderResponse, CreditBalanceInfo, CurrentStatus, DataUpdates, Dates, DebugInfo, Dimension, Dimensions, DiscountRules, DispatchManifest, Document, DpConfiguration, DPDetailsData, EinvoiceInfo, EInvoicePortalDetails, EInvoiceResponseData, EInvoiceRetry, EInvoiceRetryResponse, EInvoiceRetryShipmentData, Entities, EntitiesDataUpdates, EntitiesReasons, EntityReasonData, Error, ErrorDetail, ErrorResponse, FetchCreditBalanceRequestPayload, FetchCreditBalanceResponsePayload, FileResponse, FilterInfoOption, FiltersInfo, FiltersResponse, FinancialBreakup, Formatted, FulfillingStore, FyndOrderIdList, GeneratePosOrderReceiptResponse, GetActionsResponse, GetBagsPlatformResponse, GiftCard, GSTDetailsData, HistoryDict, HistoryMeta, HistoryReason, Identifier, InvalidateShipmentCacheNestedResponse, InvalidateShipmentCachePayload, InvalidateShipmentCacheResponse, InvoiceInfo, Item, ItemCriterias, LaneConfigResponse, LineItem, LocationDetails, LockData, MarketPlacePdf, Meta, OrderBagArticle, OrderBags, OrderBrandName, OrderConfig, OrderData, OrderDetails, OrderDetailsData, OrderDetailsResponse, OrderInfo, OrderingStoreDetails, OrderItemDataUpdates, OrderListingResponse, OrderMeta, OrderPriority, OrderStatus, OrderStatusData, OrderStatusResult, OrderUser, OriginalFilter, Page, PageDetails, PaymentInfo, PaymentMethod, PaymentMethods, PDFLinks, PhoneDetails, PlatformArticleAttributes, PlatformBreakupValues, PlatformChannel, PlatformDeliveryAddress, PlatformItem, PlatformOrderItems, PlatformOrderUpdate, PlatformShipment, PlatformShipmentReasonsResponse, PlatformShipmentTrack, PlatformTrack, PlatformUserDetails, PointBlankOtpData, PostActivityHistory, PostHistoryData, PostHistoryDict, PostHistoryFilters, PostShipmentHistory, Prices, ProcessingDates, Products, ProductsDataUpdates, ProductsDataUpdatesFilters, ProductsReasons, ProductsReasonsData, ProductsReasonsFilters, QuestionSet, Reason, ReasonsData, RefundModeConfigRequestPayload, RefundModeConfigResponsePayload, RefundModeInfo, RefundOption, ReplacementDetails, ResponseDetail, ReturnConfig, ReturnConfig1, RoleBaseStateTransitionMapping, SendSmsPayload, SendUserMobileOTP, SendUserMobileOtpResponse, Shipment, ShipmentConfig, ShipmentData, ShipmentDetail, ShipmentDetails, ShipmentHistoryResponse, ShipmentInfoResponse, ShipmentInternalPlatformViewResponse, ShipmentItem, ShipmentItemFulFillingStore, ShipmentItemMeta, ShipmentListingBrand, ShipmentListingChannel, ShipmentMeta, ShipmentPayments, ShipmentReasonsResponse, ShipmentResponseReasons, ShipmentsRequest, ShipmentsResponse, ShipmentStatus, ShipmentStatusData, ShipmentTags, ShipmentTimeStamp, ShippingInfo, SmsDataPayload, StatuesRequest, StatuesResponse, Store, StoreAddress, StoreDocuments, StoreEinvoice, StoreEwaybill, StoreGstCredentials, StoreMeta, StoreReassign, StoreReassignResponse, SubLane, SuccessResponse, SuperLane, Tax, TaxDetails, TaxInfo, TrackingList, TransactionData, UpdatePackagingDimensionsPayload, UpdatePackagingDimensionsResponse, UpdateShipmentLockPayload, UpdateShipmentLockResponse, UpdateShipmentStatusRequest, UpdateShipmentStatusResponseBody, UploadConsent, URL, UserData, UserDataInfo, UserDetailsData, VerifyMobileOTP, VerifyOtpData, VerifyOtpResponse, VerifyOtpResponseData, Weight };
|
|
2258
2347
|
}
|
|
2259
2348
|
/** @returns {ActionInfo} */
|
|
2260
2349
|
declare function ActionInfo(): ActionInfo;
|
|
@@ -2834,6 +2923,48 @@ type BulkActionTemplateResponse = {
|
|
|
2834
2923
|
*/
|
|
2835
2924
|
template_x_slug?: BulkActionTemplate[];
|
|
2836
2925
|
};
|
|
2926
|
+
/** @returns {BulkReportsDownloadFailedResponse} */
|
|
2927
|
+
declare function BulkReportsDownloadFailedResponse(): BulkReportsDownloadFailedResponse;
|
|
2928
|
+
type BulkReportsDownloadFailedResponse = {
|
|
2929
|
+
error?: string;
|
|
2930
|
+
status?: boolean;
|
|
2931
|
+
};
|
|
2932
|
+
/** @returns {BulkReportsDownloadRequest} */
|
|
2933
|
+
declare function BulkReportsDownloadRequest(): BulkReportsDownloadRequest;
|
|
2934
|
+
type BulkReportsDownloadRequest = {
|
|
2935
|
+
custom_filters_for_lane?: any;
|
|
2936
|
+
/**
|
|
2937
|
+
* - Download report with specific headers
|
|
2938
|
+
*/
|
|
2939
|
+
custom_headers?: string;
|
|
2940
|
+
/**
|
|
2941
|
+
* - Download for specific enitites, entities
|
|
2942
|
+
* can be bag, shipment or order_id, etc.
|
|
2943
|
+
*/
|
|
2944
|
+
entities?: string[];
|
|
2945
|
+
filter_type?: string;
|
|
2946
|
+
from_date?: string;
|
|
2947
|
+
/**
|
|
2948
|
+
* - Download lanes for cross company.
|
|
2949
|
+
*/
|
|
2950
|
+
is_cross_company_enabled?: boolean;
|
|
2951
|
+
lane_type?: string;
|
|
2952
|
+
/**
|
|
2953
|
+
* - Type of report
|
|
2954
|
+
*/
|
|
2955
|
+
report_type?: string;
|
|
2956
|
+
/**
|
|
2957
|
+
* - Download for specific store ids.
|
|
2958
|
+
*/
|
|
2959
|
+
store_ids?: string[];
|
|
2960
|
+
to_date?: string;
|
|
2961
|
+
};
|
|
2962
|
+
/** @returns {BulkReportsDownloadResponse} */
|
|
2963
|
+
declare function BulkReportsDownloadResponse(): BulkReportsDownloadResponse;
|
|
2964
|
+
type BulkReportsDownloadResponse = {
|
|
2965
|
+
batch_id?: string;
|
|
2966
|
+
success?: boolean;
|
|
2967
|
+
};
|
|
2837
2968
|
/** @returns {BuyerDetails} */
|
|
2838
2969
|
declare function BuyerDetails(): BuyerDetails;
|
|
2839
2970
|
type BuyerDetails = {
|
|
@@ -2926,6 +3057,71 @@ type ContactDetails = {
|
|
|
2926
3057
|
emails?: string[];
|
|
2927
3058
|
phone?: PhoneDetails[];
|
|
2928
3059
|
};
|
|
3060
|
+
/** @returns {CourierPartnerTrackingDetails} */
|
|
3061
|
+
declare function CourierPartnerTrackingDetails(): CourierPartnerTrackingDetails;
|
|
3062
|
+
type CourierPartnerTrackingDetails = {
|
|
3063
|
+
/**
|
|
3064
|
+
* - AWB Number
|
|
3065
|
+
*/
|
|
3066
|
+
awb: string;
|
|
3067
|
+
/**
|
|
3068
|
+
* - Current location of Courier partner
|
|
3069
|
+
*/
|
|
3070
|
+
dp_location?: string;
|
|
3071
|
+
/**
|
|
3072
|
+
* - Courier Partner name
|
|
3073
|
+
*/
|
|
3074
|
+
dp_name: string;
|
|
3075
|
+
/**
|
|
3076
|
+
* - Status at Courier partner end
|
|
3077
|
+
*/
|
|
3078
|
+
dp_status: string;
|
|
3079
|
+
/**
|
|
3080
|
+
* - Date Time at which status was
|
|
3081
|
+
* updated at Courier partner
|
|
3082
|
+
*/
|
|
3083
|
+
dp_status_updated_at: string;
|
|
3084
|
+
/**
|
|
3085
|
+
* - Estimated delivery date
|
|
3086
|
+
* received from Courier partner
|
|
3087
|
+
*/
|
|
3088
|
+
estimated_delivery_date?: string;
|
|
3089
|
+
/**
|
|
3090
|
+
* - Id of Tracking history
|
|
3091
|
+
*/
|
|
3092
|
+
id?: number;
|
|
3093
|
+
/**
|
|
3094
|
+
* - Journey type of the shipment
|
|
3095
|
+
*/
|
|
3096
|
+
journey: string;
|
|
3097
|
+
/**
|
|
3098
|
+
* - Meta field to store Courier partner's meta data
|
|
3099
|
+
*/
|
|
3100
|
+
meta?: any;
|
|
3101
|
+
/**
|
|
3102
|
+
* - Operational status of OMS
|
|
3103
|
+
*/
|
|
3104
|
+
operational_status: string;
|
|
3105
|
+
/**
|
|
3106
|
+
* - Promised delivery date received
|
|
3107
|
+
* from Courier partner
|
|
3108
|
+
*/
|
|
3109
|
+
promised_delivery_date?: string;
|
|
3110
|
+
/**
|
|
3111
|
+
* - Remark from courier partner
|
|
3112
|
+
*/
|
|
3113
|
+
remark?: string;
|
|
3114
|
+
/**
|
|
3115
|
+
* - Shipment ID
|
|
3116
|
+
*/
|
|
3117
|
+
shipment_id: string;
|
|
3118
|
+
};
|
|
3119
|
+
/** @returns {CourierPartnerTrackingResponse} */
|
|
3120
|
+
declare function CourierPartnerTrackingResponse(): CourierPartnerTrackingResponse;
|
|
3121
|
+
type CourierPartnerTrackingResponse = {
|
|
3122
|
+
items?: CourierPartnerTrackingDetails[];
|
|
3123
|
+
page?: PageDetails;
|
|
3124
|
+
};
|
|
2929
3125
|
/** @returns {CreateChannelConfig} */
|
|
2930
3126
|
declare function CreateChannelConfig(): CreateChannelConfig;
|
|
2931
3127
|
type CreateChannelConfig = {
|
|
@@ -3109,6 +3305,36 @@ type EInvoicePortalDetails = {
|
|
|
3109
3305
|
user?: string;
|
|
3110
3306
|
username?: string;
|
|
3111
3307
|
};
|
|
3308
|
+
/** @returns {EInvoiceResponseData} */
|
|
3309
|
+
declare function EInvoiceResponseData(): EInvoiceResponseData;
|
|
3310
|
+
type EInvoiceResponseData = {
|
|
3311
|
+
ack_dt?: string;
|
|
3312
|
+
ack_no?: string;
|
|
3313
|
+
irn?: string;
|
|
3314
|
+
message: string;
|
|
3315
|
+
shipment_id: string;
|
|
3316
|
+
success: boolean;
|
|
3317
|
+
timeout?: number;
|
|
3318
|
+
timeout_unit?: string;
|
|
3319
|
+
};
|
|
3320
|
+
/** @returns {EInvoiceRetry} */
|
|
3321
|
+
declare function EInvoiceRetry(): EInvoiceRetry;
|
|
3322
|
+
type EInvoiceRetry = {
|
|
3323
|
+
shipments_data?: EInvoiceRetryShipmentData[];
|
|
3324
|
+
};
|
|
3325
|
+
/** @returns {EInvoiceRetryResponse} */
|
|
3326
|
+
declare function EInvoiceRetryResponse(): EInvoiceRetryResponse;
|
|
3327
|
+
type EInvoiceRetryResponse = {
|
|
3328
|
+
message?: string;
|
|
3329
|
+
response_data: EInvoiceResponseData[];
|
|
3330
|
+
success?: boolean;
|
|
3331
|
+
success_count: number;
|
|
3332
|
+
};
|
|
3333
|
+
/** @returns {EInvoiceRetryShipmentData} */
|
|
3334
|
+
declare function EInvoiceRetryShipmentData(): EInvoiceRetryShipmentData;
|
|
3335
|
+
type EInvoiceRetryShipmentData = {
|
|
3336
|
+
shipment_id: string;
|
|
3337
|
+
};
|
|
3112
3338
|
/** @returns {Entities} */
|
|
3113
3339
|
declare function Entities(): Entities;
|
|
3114
3340
|
type Entities = {
|
|
@@ -3522,7 +3748,7 @@ type LaneConfigResponse = {
|
|
|
3522
3748
|
declare function LineItem(): LineItem;
|
|
3523
3749
|
type LineItem = {
|
|
3524
3750
|
charges?: Charge[];
|
|
3525
|
-
|
|
3751
|
+
custom_message?: string;
|
|
3526
3752
|
external_line_id?: string;
|
|
3527
3753
|
meta?: any;
|
|
3528
3754
|
quantity?: number;
|
|
@@ -3784,6 +4010,31 @@ type Page = {
|
|
|
3784
4010
|
size?: number;
|
|
3785
4011
|
type: string;
|
|
3786
4012
|
};
|
|
4013
|
+
/** @returns {PageDetails} */
|
|
4014
|
+
declare function PageDetails(): PageDetails;
|
|
4015
|
+
type PageDetails = {
|
|
4016
|
+
/**
|
|
4017
|
+
* - Current page number
|
|
4018
|
+
*/
|
|
4019
|
+
current?: number;
|
|
4020
|
+
/**
|
|
4021
|
+
* - If next page contains any result
|
|
4022
|
+
*/
|
|
4023
|
+
has_next?: boolean;
|
|
4024
|
+
/**
|
|
4025
|
+
* - Total count of the results present in the
|
|
4026
|
+
* requested filter
|
|
4027
|
+
*/
|
|
4028
|
+
item_total: number;
|
|
4029
|
+
/**
|
|
4030
|
+
* - Page size
|
|
4031
|
+
*/
|
|
4032
|
+
size?: number;
|
|
4033
|
+
/**
|
|
4034
|
+
* - Type of the page
|
|
4035
|
+
*/
|
|
4036
|
+
type?: string;
|
|
4037
|
+
};
|
|
3787
4038
|
/** @returns {PaymentInfo} */
|
|
3788
4039
|
declare function PaymentInfo(): PaymentInfo;
|
|
3789
4040
|
type PaymentInfo = {
|
|
@@ -4216,6 +4467,12 @@ type ReturnConfig1 = {
|
|
|
4216
4467
|
time?: number;
|
|
4217
4468
|
unit?: string;
|
|
4218
4469
|
};
|
|
4470
|
+
/** @returns {RoleBaseStateTransitionMapping} */
|
|
4471
|
+
declare function RoleBaseStateTransitionMapping(): RoleBaseStateTransitionMapping;
|
|
4472
|
+
type RoleBaseStateTransitionMapping = {
|
|
4473
|
+
next_statuses?: string[];
|
|
4474
|
+
success?: boolean;
|
|
4475
|
+
};
|
|
4219
4476
|
/** @returns {SendSmsPayload} */
|
|
4220
4477
|
declare function SendSmsPayload(): SendSmsPayload;
|
|
4221
4478
|
type SendSmsPayload = {
|
|
@@ -4792,6 +5049,7 @@ declare function TaxInfo(): TaxInfo;
|
|
|
4792
5049
|
type TaxInfo = {
|
|
4793
5050
|
b2b_gstin_number?: string;
|
|
4794
5051
|
gstin?: string;
|
|
5052
|
+
pan_no?: string;
|
|
4795
5053
|
};
|
|
4796
5054
|
/** @returns {TrackingList} */
|
|
4797
5055
|
declare function TrackingList(): TrackingList;
|
|
@@ -563,6 +563,33 @@ const Joi = require("joi");
|
|
|
563
563
|
* @property {BulkActionTemplate[]} [template_x_slug] - Allowed bulk action template slugs
|
|
564
564
|
*/
|
|
565
565
|
|
|
566
|
+
/**
|
|
567
|
+
* @typedef BulkReportsDownloadFailedResponse
|
|
568
|
+
* @property {string} [error]
|
|
569
|
+
* @property {boolean} [status]
|
|
570
|
+
*/
|
|
571
|
+
|
|
572
|
+
/**
|
|
573
|
+
* @typedef BulkReportsDownloadRequest
|
|
574
|
+
* @property {Object} [custom_filters_for_lane]
|
|
575
|
+
* @property {string} [custom_headers] - Download report with specific headers
|
|
576
|
+
* @property {string[]} [entities] - Download for specific enitites, entities
|
|
577
|
+
* can be bag, shipment or order_id, etc.
|
|
578
|
+
* @property {string} [filter_type]
|
|
579
|
+
* @property {string} [from_date]
|
|
580
|
+
* @property {boolean} [is_cross_company_enabled] - Download lanes for cross company.
|
|
581
|
+
* @property {string} [lane_type]
|
|
582
|
+
* @property {string} [report_type] - Type of report
|
|
583
|
+
* @property {string[]} [store_ids] - Download for specific store ids.
|
|
584
|
+
* @property {string} [to_date]
|
|
585
|
+
*/
|
|
586
|
+
|
|
587
|
+
/**
|
|
588
|
+
* @typedef BulkReportsDownloadResponse
|
|
589
|
+
* @property {string} [batch_id]
|
|
590
|
+
* @property {boolean} [success]
|
|
591
|
+
*/
|
|
592
|
+
|
|
566
593
|
/**
|
|
567
594
|
* @typedef BuyerDetails
|
|
568
595
|
* @property {string} address
|
|
@@ -625,6 +652,32 @@ const Joi = require("joi");
|
|
|
625
652
|
* @property {PhoneDetails[]} [phone]
|
|
626
653
|
*/
|
|
627
654
|
|
|
655
|
+
/**
|
|
656
|
+
* @typedef CourierPartnerTrackingDetails
|
|
657
|
+
* @property {string} awb - AWB Number
|
|
658
|
+
* @property {string} [dp_location] - Current location of Courier partner
|
|
659
|
+
* @property {string} dp_name - Courier Partner name
|
|
660
|
+
* @property {string} dp_status - Status at Courier partner end
|
|
661
|
+
* @property {string} dp_status_updated_at - Date Time at which status was
|
|
662
|
+
* updated at Courier partner
|
|
663
|
+
* @property {string} [estimated_delivery_date] - Estimated delivery date
|
|
664
|
+
* received from Courier partner
|
|
665
|
+
* @property {number} [id] - Id of Tracking history
|
|
666
|
+
* @property {string} journey - Journey type of the shipment
|
|
667
|
+
* @property {Object} [meta] - Meta field to store Courier partner's meta data
|
|
668
|
+
* @property {string} operational_status - Operational status of OMS
|
|
669
|
+
* @property {string} [promised_delivery_date] - Promised delivery date received
|
|
670
|
+
* from Courier partner
|
|
671
|
+
* @property {string} [remark] - Remark from courier partner
|
|
672
|
+
* @property {string} shipment_id - Shipment ID
|
|
673
|
+
*/
|
|
674
|
+
|
|
675
|
+
/**
|
|
676
|
+
* @typedef CourierPartnerTrackingResponse
|
|
677
|
+
* @property {CourierPartnerTrackingDetails[]} [items]
|
|
678
|
+
* @property {PageDetails} [page]
|
|
679
|
+
*/
|
|
680
|
+
|
|
628
681
|
/**
|
|
629
682
|
* @typedef CreateChannelConfig
|
|
630
683
|
* @property {DpConfiguration} [dp_configuration]
|
|
@@ -808,6 +861,36 @@ const Joi = require("joi");
|
|
|
808
861
|
* @property {string} [username]
|
|
809
862
|
*/
|
|
810
863
|
|
|
864
|
+
/**
|
|
865
|
+
* @typedef EInvoiceResponseData
|
|
866
|
+
* @property {string} [ack_dt]
|
|
867
|
+
* @property {string} [ack_no]
|
|
868
|
+
* @property {string} [irn]
|
|
869
|
+
* @property {string} message
|
|
870
|
+
* @property {string} shipment_id
|
|
871
|
+
* @property {boolean} success
|
|
872
|
+
* @property {number} [timeout]
|
|
873
|
+
* @property {string} [timeout_unit]
|
|
874
|
+
*/
|
|
875
|
+
|
|
876
|
+
/**
|
|
877
|
+
* @typedef EInvoiceRetry
|
|
878
|
+
* @property {EInvoiceRetryShipmentData[]} [shipments_data]
|
|
879
|
+
*/
|
|
880
|
+
|
|
881
|
+
/**
|
|
882
|
+
* @typedef EInvoiceRetryResponse
|
|
883
|
+
* @property {string} [message]
|
|
884
|
+
* @property {EInvoiceResponseData[]} response_data
|
|
885
|
+
* @property {boolean} [success]
|
|
886
|
+
* @property {number} success_count
|
|
887
|
+
*/
|
|
888
|
+
|
|
889
|
+
/**
|
|
890
|
+
* @typedef EInvoiceRetryShipmentData
|
|
891
|
+
* @property {string} shipment_id
|
|
892
|
+
*/
|
|
893
|
+
|
|
811
894
|
/**
|
|
812
895
|
* @typedef Entities
|
|
813
896
|
* @property {string} [affiliate_bag_id] - Application/Affiliate Bag ID,
|
|
@@ -1151,7 +1234,7 @@ const Joi = require("joi");
|
|
|
1151
1234
|
/**
|
|
1152
1235
|
* @typedef LineItem
|
|
1153
1236
|
* @property {Charge[]} [charges]
|
|
1154
|
-
* @property {string} [
|
|
1237
|
+
* @property {string} [custom_message]
|
|
1155
1238
|
* @property {string} [external_line_id]
|
|
1156
1239
|
* @property {Object} [meta]
|
|
1157
1240
|
* @property {number} [quantity]
|
|
@@ -1408,6 +1491,16 @@ const Joi = require("joi");
|
|
|
1408
1491
|
* @property {string} type
|
|
1409
1492
|
*/
|
|
1410
1493
|
|
|
1494
|
+
/**
|
|
1495
|
+
* @typedef PageDetails
|
|
1496
|
+
* @property {number} [current] - Current page number
|
|
1497
|
+
* @property {boolean} [has_next] - If next page contains any result
|
|
1498
|
+
* @property {number} item_total - Total count of the results present in the
|
|
1499
|
+
* requested filter
|
|
1500
|
+
* @property {number} [size] - Page size
|
|
1501
|
+
* @property {string} [type] - Type of the page
|
|
1502
|
+
*/
|
|
1503
|
+
|
|
1411
1504
|
/**
|
|
1412
1505
|
* @typedef PaymentInfo
|
|
1413
1506
|
* @property {PaymentMethod[]} [payment_methods]
|
|
@@ -1819,6 +1912,12 @@ const Joi = require("joi");
|
|
|
1819
1912
|
* @property {string} [unit]
|
|
1820
1913
|
*/
|
|
1821
1914
|
|
|
1915
|
+
/**
|
|
1916
|
+
* @typedef RoleBaseStateTransitionMapping
|
|
1917
|
+
* @property {string[]} [next_statuses]
|
|
1918
|
+
* @property {boolean} [success]
|
|
1919
|
+
*/
|
|
1920
|
+
|
|
1822
1921
|
/**
|
|
1823
1922
|
* @typedef SendSmsPayload
|
|
1824
1923
|
* @property {number} bag_id - Bag_id for the activity history track
|
|
@@ -2346,6 +2445,7 @@ const Joi = require("joi");
|
|
|
2346
2445
|
* @typedef TaxInfo
|
|
2347
2446
|
* @property {string} [b2b_gstin_number]
|
|
2348
2447
|
* @property {string} [gstin]
|
|
2448
|
+
* @property {string} [pan_no]
|
|
2349
2449
|
*/
|
|
2350
2450
|
|
|
2351
2451
|
/**
|
|
@@ -3162,6 +3262,38 @@ class OrderPlatformModel {
|
|
|
3162
3262
|
});
|
|
3163
3263
|
}
|
|
3164
3264
|
|
|
3265
|
+
/** @returns {BulkReportsDownloadFailedResponse} */
|
|
3266
|
+
static BulkReportsDownloadFailedResponse() {
|
|
3267
|
+
return Joi.object({
|
|
3268
|
+
error: Joi.string().allow(""),
|
|
3269
|
+
status: Joi.boolean(),
|
|
3270
|
+
});
|
|
3271
|
+
}
|
|
3272
|
+
|
|
3273
|
+
/** @returns {BulkReportsDownloadRequest} */
|
|
3274
|
+
static BulkReportsDownloadRequest() {
|
|
3275
|
+
return Joi.object({
|
|
3276
|
+
custom_filters_for_lane: Joi.any(),
|
|
3277
|
+
custom_headers: Joi.string().allow(""),
|
|
3278
|
+
entities: Joi.array().items(Joi.string().allow("")),
|
|
3279
|
+
filter_type: Joi.string().allow(""),
|
|
3280
|
+
from_date: Joi.string().allow(""),
|
|
3281
|
+
is_cross_company_enabled: Joi.boolean(),
|
|
3282
|
+
lane_type: Joi.string().allow(""),
|
|
3283
|
+
report_type: Joi.string().allow(""),
|
|
3284
|
+
store_ids: Joi.array().items(Joi.string().allow("")),
|
|
3285
|
+
to_date: Joi.string().allow(""),
|
|
3286
|
+
});
|
|
3287
|
+
}
|
|
3288
|
+
|
|
3289
|
+
/** @returns {BulkReportsDownloadResponse} */
|
|
3290
|
+
static BulkReportsDownloadResponse() {
|
|
3291
|
+
return Joi.object({
|
|
3292
|
+
batch_id: Joi.string().allow(""),
|
|
3293
|
+
success: Joi.boolean(),
|
|
3294
|
+
});
|
|
3295
|
+
}
|
|
3296
|
+
|
|
3165
3297
|
/** @returns {BuyerDetails} */
|
|
3166
3298
|
static BuyerDetails() {
|
|
3167
3299
|
return Joi.object({
|
|
@@ -3237,6 +3369,35 @@ class OrderPlatformModel {
|
|
|
3237
3369
|
});
|
|
3238
3370
|
}
|
|
3239
3371
|
|
|
3372
|
+
/** @returns {CourierPartnerTrackingDetails} */
|
|
3373
|
+
static CourierPartnerTrackingDetails() {
|
|
3374
|
+
return Joi.object({
|
|
3375
|
+
awb: Joi.string().allow("").required(),
|
|
3376
|
+
dp_location: Joi.string().allow("").allow(null),
|
|
3377
|
+
dp_name: Joi.string().allow("").required(),
|
|
3378
|
+
dp_status: Joi.string().allow("").required(),
|
|
3379
|
+
dp_status_updated_at: Joi.string().allow("").required(),
|
|
3380
|
+
estimated_delivery_date: Joi.string().allow("").allow(null),
|
|
3381
|
+
id: Joi.number(),
|
|
3382
|
+
journey: Joi.string().allow("").required(),
|
|
3383
|
+
meta: Joi.any(),
|
|
3384
|
+
operational_status: Joi.string().allow("").required(),
|
|
3385
|
+
promised_delivery_date: Joi.string().allow("").allow(null),
|
|
3386
|
+
remark: Joi.string().allow("").allow(null),
|
|
3387
|
+
shipment_id: Joi.string().allow("").required(),
|
|
3388
|
+
});
|
|
3389
|
+
}
|
|
3390
|
+
|
|
3391
|
+
/** @returns {CourierPartnerTrackingResponse} */
|
|
3392
|
+
static CourierPartnerTrackingResponse() {
|
|
3393
|
+
return Joi.object({
|
|
3394
|
+
items: Joi.array().items(
|
|
3395
|
+
OrderPlatformModel.CourierPartnerTrackingDetails()
|
|
3396
|
+
),
|
|
3397
|
+
page: OrderPlatformModel.PageDetails(),
|
|
3398
|
+
});
|
|
3399
|
+
}
|
|
3400
|
+
|
|
3240
3401
|
/** @returns {CreateChannelConfig} */
|
|
3241
3402
|
static CreateChannelConfig() {
|
|
3242
3403
|
return Joi.object({
|
|
@@ -3468,6 +3629,48 @@ class OrderPlatformModel {
|
|
|
3468
3629
|
});
|
|
3469
3630
|
}
|
|
3470
3631
|
|
|
3632
|
+
/** @returns {EInvoiceResponseData} */
|
|
3633
|
+
static EInvoiceResponseData() {
|
|
3634
|
+
return Joi.object({
|
|
3635
|
+
ack_dt: Joi.string().allow(""),
|
|
3636
|
+
ack_no: Joi.string().allow(""),
|
|
3637
|
+
irn: Joi.string().allow(""),
|
|
3638
|
+
message: Joi.string().allow("").required(),
|
|
3639
|
+
shipment_id: Joi.string().allow("").required(),
|
|
3640
|
+
success: Joi.boolean().required(),
|
|
3641
|
+
timeout: Joi.number(),
|
|
3642
|
+
timeout_unit: Joi.string().allow(""),
|
|
3643
|
+
});
|
|
3644
|
+
}
|
|
3645
|
+
|
|
3646
|
+
/** @returns {EInvoiceRetry} */
|
|
3647
|
+
static EInvoiceRetry() {
|
|
3648
|
+
return Joi.object({
|
|
3649
|
+
shipments_data: Joi.array().items(
|
|
3650
|
+
OrderPlatformModel.EInvoiceRetryShipmentData()
|
|
3651
|
+
),
|
|
3652
|
+
});
|
|
3653
|
+
}
|
|
3654
|
+
|
|
3655
|
+
/** @returns {EInvoiceRetryResponse} */
|
|
3656
|
+
static EInvoiceRetryResponse() {
|
|
3657
|
+
return Joi.object({
|
|
3658
|
+
message: Joi.string().allow(""),
|
|
3659
|
+
response_data: Joi.array()
|
|
3660
|
+
.items(OrderPlatformModel.EInvoiceResponseData())
|
|
3661
|
+
.required(),
|
|
3662
|
+
success: Joi.boolean(),
|
|
3663
|
+
success_count: Joi.number().required(),
|
|
3664
|
+
});
|
|
3665
|
+
}
|
|
3666
|
+
|
|
3667
|
+
/** @returns {EInvoiceRetryShipmentData} */
|
|
3668
|
+
static EInvoiceRetryShipmentData() {
|
|
3669
|
+
return Joi.object({
|
|
3670
|
+
shipment_id: Joi.string().allow("").required(),
|
|
3671
|
+
});
|
|
3672
|
+
}
|
|
3673
|
+
|
|
3471
3674
|
/** @returns {Entities} */
|
|
3472
3675
|
static Entities() {
|
|
3473
3676
|
return Joi.object({
|
|
@@ -3874,7 +4077,7 @@ class OrderPlatformModel {
|
|
|
3874
4077
|
static LineItem() {
|
|
3875
4078
|
return Joi.object({
|
|
3876
4079
|
charges: Joi.array().items(OrderPlatformModel.Charge()),
|
|
3877
|
-
|
|
4080
|
+
custom_message: Joi.string().allow(""),
|
|
3878
4081
|
external_line_id: Joi.string().allow(""),
|
|
3879
4082
|
meta: Joi.any(),
|
|
3880
4083
|
quantity: Joi.number(),
|
|
@@ -4186,6 +4389,17 @@ class OrderPlatformModel {
|
|
|
4186
4389
|
});
|
|
4187
4390
|
}
|
|
4188
4391
|
|
|
4392
|
+
/** @returns {PageDetails} */
|
|
4393
|
+
static PageDetails() {
|
|
4394
|
+
return Joi.object({
|
|
4395
|
+
current: Joi.number(),
|
|
4396
|
+
has_next: Joi.boolean(),
|
|
4397
|
+
item_total: Joi.number().required(),
|
|
4398
|
+
size: Joi.number(),
|
|
4399
|
+
type: Joi.string().allow(""),
|
|
4400
|
+
});
|
|
4401
|
+
}
|
|
4402
|
+
|
|
4189
4403
|
/** @returns {PaymentInfo} */
|
|
4190
4404
|
static PaymentInfo() {
|
|
4191
4405
|
return Joi.object({
|
|
@@ -4686,6 +4900,14 @@ class OrderPlatformModel {
|
|
|
4686
4900
|
});
|
|
4687
4901
|
}
|
|
4688
4902
|
|
|
4903
|
+
/** @returns {RoleBaseStateTransitionMapping} */
|
|
4904
|
+
static RoleBaseStateTransitionMapping() {
|
|
4905
|
+
return Joi.object({
|
|
4906
|
+
next_statuses: Joi.array().items(Joi.string().allow("")),
|
|
4907
|
+
success: Joi.boolean(),
|
|
4908
|
+
});
|
|
4909
|
+
}
|
|
4910
|
+
|
|
4689
4911
|
/** @returns {SendSmsPayload} */
|
|
4690
4912
|
static SendSmsPayload() {
|
|
4691
4913
|
return Joi.object({
|
|
@@ -5308,6 +5530,7 @@ class OrderPlatformModel {
|
|
|
5308
5530
|
return Joi.object({
|
|
5309
5531
|
b2b_gstin_number: Joi.string().allow(""),
|
|
5310
5532
|
gstin: Joi.string().allow(""),
|
|
5533
|
+
pan_no: Joi.string().allow(""),
|
|
5311
5534
|
});
|
|
5312
5535
|
}
|
|
5313
5536
|
|