@gofynd/fdk-client-javascript 1.4.3 → 1.4.5
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 -10
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +48 -48
- package/sdk/application/Cart/CartApplicationClient.js +48 -48
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +69 -69
- package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
- package/sdk/application/Common/CommonApplicationClient.d.ts +4 -4
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +6 -6
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +32 -32
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
- package/sdk/application/Content/ContentApplicationClient.d.ts +45 -45
- package/sdk/application/Content/ContentApplicationClient.js +45 -45
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +5 -5
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +5 -5
- package/sdk/application/Lead/LeadApplicationClient.d.ts +9 -9
- package/sdk/application/Lead/LeadApplicationClient.js +9 -9
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +22 -22
- package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
- package/sdk/application/Order/OrderApplicationClient.d.ts +14 -25
- package/sdk/application/Order/OrderApplicationClient.js +14 -94
- package/sdk/application/Order/OrderApplicationValidator.d.ts +1 -15
- package/sdk/application/Order/OrderApplicationValidator.js +0 -13
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +71 -71
- package/sdk/application/Payment/PaymentApplicationClient.js +71 -71
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +1 -1
- package/sdk/application/Rewards/RewardsApplicationClient.js +1 -1
- package/sdk/application/Share/ShareApplicationClient.d.ts +1 -1
- package/sdk/application/Share/ShareApplicationClient.js +1 -1
- package/sdk/application/Share/ShareApplicationModel.d.ts +2 -0
- package/sdk/application/Share/ShareApplicationModel.js +2 -0
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +8 -8
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/User/UserApplicationClient.d.ts +74 -74
- package/sdk/application/User/UserApplicationClient.js +74 -74
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +5 -5
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +5 -5
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +13 -13
- package/sdk/platform/Billing/BillingPlatformClient.js +13 -13
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +102 -102
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +102 -102
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +132 -131
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +132 -131
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +130 -130
- package/sdk/platform/Catalog/CatalogPlatformClient.js +130 -130
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +118 -118
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +118 -118
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +22 -22
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +22 -22
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +34 -7
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +35 -5
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +4 -4
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +4 -4
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +41 -41
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +41 -41
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +26 -26
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +26 -26
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +93 -93
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +93 -93
- package/sdk/platform/Content/ContentPlatformClient.d.ts +29 -29
- package/sdk/platform/Content/ContentPlatformClient.js +29 -29
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +18 -18
- package/sdk/platform/Discount/DiscountPlatformClient.js +18 -18
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +18 -17
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +18 -17
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +2 -2
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +4 -4
- package/sdk/platform/Finance/FinancePlatformClient.js +4 -4
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +15 -15
- package/sdk/platform/Lead/LeadPlatformClient.js +15 -15
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
- package/sdk/platform/Order/OrderPlatformClient.d.ts +95 -106
- package/sdk/platform/Order/OrderPlatformClient.js +95 -190
- package/sdk/platform/Order/OrderPlatformModel.d.ts +10 -0
- package/sdk/platform/Order/OrderPlatformModel.js +4 -0
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +1 -33
- package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +77 -77
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +77 -77
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +2 -2
- package/sdk/platform/Payment/PaymentPlatformClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +7 -0
- package/sdk/platform/Payment/PaymentPlatformModel.js +3 -0
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +7 -7
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +7 -7
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +40 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +51 -50
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +51 -50
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.js +1 -1
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -0
- package/sdk/platform/Share/SharePlatformModel.js +2 -0
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +34 -104
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +34 -591
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +1 -100
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +6 -6
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +35 -35
- package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +7 -6
- package/sdk/platform/Webhook/WebhookPlatformClient.js +7 -6
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/platform/Inventory/InventoryPlatformClient.d.ts +0 -152
- package/sdk/platform/Inventory/InventoryPlatformClient.js +0 -1017
- package/sdk/platform/Inventory/InventoryPlatformModel.d.ts +0 -1355
- package/sdk/platform/Inventory/InventoryPlatformModel.js +0 -1544
- package/sdk/platform/Inventory/InventoryPlatformValidator.d.ts +0 -171
- package/sdk/platform/Inventory/InventoryPlatformValidator.js +0 -159
|
@@ -53,8 +53,8 @@ class Logistic {
|
|
|
53
53
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
54
54
|
* @returns {Promise<LogisticApplicationModel.CountryListResponse>} - Success response
|
|
55
55
|
* @name getAllCountries
|
|
56
|
-
* @summary:
|
|
57
|
-
* @description:
|
|
56
|
+
* @summary: Get deliverable countries
|
|
57
|
+
* @description: Retrieves a list of countries within the specified delivery zones for that application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getAllCountries/).
|
|
58
58
|
*/
|
|
59
59
|
async getAllCountries(
|
|
60
60
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -131,8 +131,8 @@ class Logistic {
|
|
|
131
131
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
132
132
|
* @returns {Promise<LogisticApplicationModel.GetCountries>} - Success response
|
|
133
133
|
* @name getCountries
|
|
134
|
-
* @summary: Get
|
|
135
|
-
* @description:
|
|
134
|
+
* @summary: Get countries
|
|
135
|
+
* @description: Fetch the list of supported countries. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCountries/).
|
|
136
136
|
*/
|
|
137
137
|
async getCountries(
|
|
138
138
|
{ onboarding, pageNo, pageSize, q, requestHeaders } = {
|
|
@@ -215,8 +215,8 @@ class Logistic {
|
|
|
215
215
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
216
216
|
* @returns {Promise<LogisticApplicationModel.GetCountry>} - Success response
|
|
217
217
|
* @name getCountry
|
|
218
|
-
* @summary: Get
|
|
219
|
-
* @description:
|
|
218
|
+
* @summary: Get country details
|
|
219
|
+
* @description: Fetch details about a particular country and its address format customized for different business scenarios. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCountry/).
|
|
220
220
|
*/
|
|
221
221
|
async getCountry(
|
|
222
222
|
{ countryIsoCode, requestHeaders } = { requestHeaders: {} },
|
|
@@ -293,8 +293,8 @@ class Logistic {
|
|
|
293
293
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
294
294
|
* @returns {Promise<LogisticApplicationModel.GetLocalities>} - Success response
|
|
295
295
|
* @name getLocalities
|
|
296
|
-
* @summary: Get
|
|
297
|
-
* @description:
|
|
296
|
+
* @summary: Get localities
|
|
297
|
+
* @description: Retrieve geographical data for a specific type of locality based on the provided filters. For instance, obtain a list of cities for a given country and state. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocalities/).
|
|
298
298
|
*/
|
|
299
299
|
async getLocalities(
|
|
300
300
|
{
|
|
@@ -386,8 +386,8 @@ class Logistic {
|
|
|
386
386
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
387
387
|
* @returns {Promise<LogisticApplicationModel.GetLocality>} - Success response
|
|
388
388
|
* @name getLocality
|
|
389
|
-
* @summary: Get
|
|
390
|
-
* @description:
|
|
389
|
+
* @summary: Get locality detail
|
|
390
|
+
* @description: Retrieve detailed geographical data for a specific locality, such as a pincode. For example, for a pincode value of 400603, the service returns its parent locations, including city, state, and country details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocality/).
|
|
391
391
|
*/
|
|
392
392
|
async getLocality(
|
|
393
393
|
{ localityType, localityValue, country, state, city, requestHeaders } = {
|
|
@@ -469,8 +469,8 @@ class Logistic {
|
|
|
469
469
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
470
470
|
* @returns {Promise<LogisticApplicationModel.GetStoreResponse>} - Success response
|
|
471
471
|
* @name getLocations
|
|
472
|
-
* @summary:
|
|
473
|
-
* @description: Retrieves
|
|
472
|
+
* @summary: Get available selling locations
|
|
473
|
+
* @description: Retrieves stores available for the application based on Delivery Zones and Order Orchestration rules. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getLocations/).
|
|
474
474
|
*/
|
|
475
475
|
async getLocations(
|
|
476
476
|
{
|
|
@@ -588,8 +588,8 @@ class Logistic {
|
|
|
588
588
|
* @returns {Promise<LogisticApplicationModel.ReAssignStoreResponse>} -
|
|
589
589
|
* Success response
|
|
590
590
|
* @name getOptimalLocations
|
|
591
|
-
* @summary:
|
|
592
|
-
* @description:
|
|
591
|
+
* @summary: Get selling locations
|
|
592
|
+
* @description: Determines and returns the best fulfillment center for customers by analyzing their location, product availability, and inventory levels. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getOptimalLocations/).
|
|
593
593
|
*/
|
|
594
594
|
async getOptimalLocations(
|
|
595
595
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -668,8 +668,8 @@ class Logistic {
|
|
|
668
668
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
669
669
|
* @returns {Promise<LogisticApplicationModel.PincodeApiResponse>} - Success response
|
|
670
670
|
* @name getPincodeCity
|
|
671
|
-
* @summary:
|
|
672
|
-
* @description: Retrieve
|
|
671
|
+
* @summary: Get pincode details
|
|
672
|
+
* @description: Retrieve details of a specific pincode, such as obtaining its city and state information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeCity/).
|
|
673
673
|
*/
|
|
674
674
|
async getPincodeCity(
|
|
675
675
|
{ pincode, requestHeaders } = { requestHeaders: {} },
|
|
@@ -748,8 +748,8 @@ class Logistic {
|
|
|
748
748
|
* - Success response
|
|
749
749
|
*
|
|
750
750
|
* @name getPincodeZones
|
|
751
|
-
* @summary:
|
|
752
|
-
* @description:
|
|
751
|
+
* @summary: Get zones
|
|
752
|
+
* @description: Retrieve the delivery zone associated with a given pincode - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeZones/).
|
|
753
753
|
*/
|
|
754
754
|
async getPincodeZones(
|
|
755
755
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -826,8 +826,8 @@ class Logistic {
|
|
|
826
826
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
827
827
|
* @returns {Promise<LogisticApplicationModel.TATViewResponse>} - Success response
|
|
828
828
|
* @name getTatProduct
|
|
829
|
-
* @summary:
|
|
830
|
-
* @description: Retrieve the estimated delivery
|
|
829
|
+
* @summary: Get product's turnaround time
|
|
830
|
+
* @description: Retrieve the estimated delivery timeframe for a specific product from a designated store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getTatProduct/).
|
|
831
831
|
*/
|
|
832
832
|
async getTatProduct(
|
|
833
833
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -905,8 +905,8 @@ class Logistic {
|
|
|
905
905
|
* @returns {Promise<LogisticApplicationModel.ValidateAddressRequest>} -
|
|
906
906
|
* Success response
|
|
907
907
|
* @name validateAddress
|
|
908
|
-
* @summary: Validate
|
|
909
|
-
* @description: Validate
|
|
908
|
+
* @summary: Validate address
|
|
909
|
+
* @description: Validate addresses using specific templates customized for each country and tailored to various business scenarios. This validation ensures that the data conforms to the information currently stored in the system. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/validateAddress/).
|
|
910
910
|
*/
|
|
911
911
|
async validateAddress(
|
|
912
912
|
{ countryIsoCode, templateName, body, requestHeaders } = {
|
|
@@ -7,7 +7,6 @@ declare class Order {
|
|
|
7
7
|
getInvoiceByShipmentId: string;
|
|
8
8
|
getOrderById: string;
|
|
9
9
|
getOrders: string;
|
|
10
|
-
getPosOrderById: string;
|
|
11
10
|
getShipmentBagReasons: string;
|
|
12
11
|
getShipmentById: string;
|
|
13
12
|
getShipmentReasons: string;
|
|
@@ -27,7 +26,7 @@ declare class Order {
|
|
|
27
26
|
* @returns {Promise<OrderApplicationModel.CustomerDetailsResponse>} -
|
|
28
27
|
* Success response
|
|
29
28
|
* @name getCustomerDetailsByShipmentId
|
|
30
|
-
* @summary:
|
|
29
|
+
* @summary: Get shipment's customer
|
|
31
30
|
* @description: Retrieve customer details such as mobile number using Shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getCustomerDetailsByShipmentId/).
|
|
32
31
|
*/
|
|
33
32
|
getCustomerDetailsByShipmentId({ orderId, shipmentId, requestHeaders }?: OrderApplicationValidator.GetCustomerDetailsByShipmentIdParam, { responseHeaders }?: object): Promise<OrderApplicationModel.CustomerDetailsResponse>;
|
|
@@ -48,8 +47,8 @@ declare class Order {
|
|
|
48
47
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
49
48
|
* @returns {Promise<OrderApplicationModel.OrderById>} - Success response
|
|
50
49
|
* @name getOrderById
|
|
51
|
-
* @summary:
|
|
52
|
-
* @description: Retrieve order details such as tracking details, shipment, store information using Fynd Order ID
|
|
50
|
+
* @summary: Get a order
|
|
51
|
+
* @description: Retrieve order details such as tracking details, shipment, store information using Fynd Order ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getOrderById/).
|
|
53
52
|
*/
|
|
54
53
|
getOrderById({ orderId, allowInactive, requestHeaders }?: OrderApplicationValidator.GetOrderByIdParam, { responseHeaders }?: object): Promise<OrderApplicationModel.OrderById>;
|
|
55
54
|
/**
|
|
@@ -58,28 +57,18 @@ declare class Order {
|
|
|
58
57
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
59
58
|
* @returns {Promise<OrderApplicationModel.OrderList>} - Success response
|
|
60
59
|
* @name getOrders
|
|
61
|
-
* @summary:
|
|
62
|
-
* @description: Retrieves all orders associated with a customer account
|
|
60
|
+
* @summary: List customer orders
|
|
61
|
+
* @description: Retrieves all orders associated with a customer account - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getOrders/).
|
|
63
62
|
*/
|
|
64
63
|
getOrders({ status, pageNo, pageSize, fromDate, toDate, startDate, endDate, customMeta, allowInactive, requestHeaders, }?: OrderApplicationValidator.GetOrdersParam, { responseHeaders }?: object): Promise<OrderApplicationModel.OrderList>;
|
|
65
|
-
/**
|
|
66
|
-
* @param {OrderApplicationValidator.GetPosOrderByIdParam} arg - Arg object.
|
|
67
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
68
|
-
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
69
|
-
* @returns {Promise<OrderApplicationModel.OrderById>} - Success response
|
|
70
|
-
* @name getPosOrderById
|
|
71
|
-
* @summary: Retrieves POS order details
|
|
72
|
-
* @description: Retrieve a POS order and all its details such as tracking details, shipment, store information using Fynd Order ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getPosOrderById/).
|
|
73
|
-
*/
|
|
74
|
-
getPosOrderById({ orderId, requestHeaders }?: OrderApplicationValidator.GetPosOrderByIdParam, { responseHeaders }?: object): Promise<OrderApplicationModel.OrderById>;
|
|
75
64
|
/**
|
|
76
65
|
* @param {OrderApplicationValidator.GetShipmentBagReasonsParam} arg - Arg object.
|
|
77
66
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
78
67
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
79
68
|
* @returns {Promise<OrderApplicationModel.ShipmentBagReasons>} - Success response
|
|
80
69
|
* @name getShipmentBagReasons
|
|
81
|
-
* @summary:
|
|
82
|
-
* @description:
|
|
70
|
+
* @summary: List bag cancellation reasons
|
|
71
|
+
* @description: Get reasons to perform full or partial cancellation of a bag - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentBagReasons/).
|
|
83
72
|
*/
|
|
84
73
|
getShipmentBagReasons({ shipmentId, bagId, requestHeaders }?: OrderApplicationValidator.GetShipmentBagReasonsParam, { responseHeaders }?: object): Promise<OrderApplicationModel.ShipmentBagReasons>;
|
|
85
74
|
/**
|
|
@@ -88,7 +77,7 @@ declare class Order {
|
|
|
88
77
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
89
78
|
* @returns {Promise<OrderApplicationModel.ShipmentById>} - Success response
|
|
90
79
|
* @name getShipmentById
|
|
91
|
-
* @summary:
|
|
80
|
+
* @summary: Get a Shipment
|
|
92
81
|
* @description: Retrieve shipment details such as price breakup, tracking details, store information, etc. using Shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentById/).
|
|
93
82
|
*/
|
|
94
83
|
getShipmentById({ shipmentId, allowInactive, requestHeaders }?: OrderApplicationValidator.GetShipmentByIdParam, { responseHeaders }?: object): Promise<OrderApplicationModel.ShipmentById>;
|
|
@@ -98,8 +87,8 @@ declare class Order {
|
|
|
98
87
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
99
88
|
* @returns {Promise<OrderApplicationModel.ShipmentReasons>} - Success response
|
|
100
89
|
* @name getShipmentReasons
|
|
101
|
-
* @summary:
|
|
102
|
-
* @description:
|
|
90
|
+
* @summary: List shipment cancellation reasons
|
|
91
|
+
* @description: Get reasons to perform full or partial cancellation of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentReasons/).
|
|
103
92
|
*/
|
|
104
93
|
getShipmentReasons({ shipmentId, requestHeaders }?: OrderApplicationValidator.GetShipmentReasonsParam, { responseHeaders }?: object): Promise<OrderApplicationModel.ShipmentReasons>;
|
|
105
94
|
/**
|
|
@@ -109,8 +98,8 @@ declare class Order {
|
|
|
109
98
|
* @returns {Promise<OrderApplicationModel.SendOtpToCustomerResponse>} -
|
|
110
99
|
* Success response
|
|
111
100
|
* @name sendOtpToShipmentCustomer
|
|
112
|
-
* @summary:
|
|
113
|
-
* @description: Sends a one-time password (OTP) to the customer for shipment verification
|
|
101
|
+
* @summary: Send OTP to customer
|
|
102
|
+
* @description: Sends a one-time password (OTP) to the customer for shipment verification - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/sendOtpToShipmentCustomer/).
|
|
114
103
|
*/
|
|
115
104
|
sendOtpToShipmentCustomer({ orderId, shipmentId, requestHeaders }?: OrderApplicationValidator.SendOtpToShipmentCustomerParam, { responseHeaders }?: object): Promise<OrderApplicationModel.SendOtpToCustomerResponse>;
|
|
116
105
|
/**
|
|
@@ -119,7 +108,7 @@ declare class Order {
|
|
|
119
108
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
120
109
|
* @returns {Promise<OrderApplicationModel.ShipmentTrack>} - Success response
|
|
121
110
|
* @name trackShipment
|
|
122
|
-
* @summary:
|
|
111
|
+
* @summary: Track shipment status
|
|
123
112
|
* @description: Track Shipment by shipment id, for application based on application Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/trackShipment/).
|
|
124
113
|
*/
|
|
125
114
|
trackShipment({ shipmentId, requestHeaders }?: OrderApplicationValidator.TrackShipmentParam, { responseHeaders }?: object): Promise<OrderApplicationModel.ShipmentTrack>;
|
|
@@ -132,7 +121,7 @@ declare class Order {
|
|
|
132
121
|
*
|
|
133
122
|
* @name updateShipmentStatus
|
|
134
123
|
* @summary: Updates shipment status
|
|
135
|
-
* @description: Modifies the current status of a specific shipment using its shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/updateShipmentStatus/).
|
|
124
|
+
* @description: Modifies the current status of a specific shipment using its shipment ID. Supports both partial and full transition as per the configured settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/updateShipmentStatus/).
|
|
136
125
|
*/
|
|
137
126
|
updateShipmentStatus({ shipmentId, body, requestHeaders }?: OrderApplicationValidator.UpdateShipmentStatusParam, { responseHeaders }?: object): Promise<OrderApplicationModel.ShipmentApplicationStatusResponse>;
|
|
138
127
|
/**
|
|
@@ -20,8 +20,6 @@ class Order {
|
|
|
20
20
|
"/service/application/order/v1.0/orders/shipments/{shipment_id}/invoice",
|
|
21
21
|
getOrderById: "/service/application/order/v1.0/orders/{order_id}",
|
|
22
22
|
getOrders: "/service/application/order/v1.0/orders",
|
|
23
|
-
getPosOrderById:
|
|
24
|
-
"/service/application/order/v1.0/orders/pos-order/{order_id}",
|
|
25
23
|
getShipmentBagReasons:
|
|
26
24
|
"/service/application/order/v1.0/orders/shipments/{shipment_id}/bags/{bag_id}/reasons",
|
|
27
25
|
getShipmentById:
|
|
@@ -62,7 +60,7 @@ class Order {
|
|
|
62
60
|
* @returns {Promise<OrderApplicationModel.CustomerDetailsResponse>} -
|
|
63
61
|
* Success response
|
|
64
62
|
* @name getCustomerDetailsByShipmentId
|
|
65
|
-
* @summary:
|
|
63
|
+
* @summary: Get shipment's customer
|
|
66
64
|
* @description: Retrieve customer details such as mobile number using Shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getCustomerDetailsByShipmentId/).
|
|
67
65
|
*/
|
|
68
66
|
async getCustomerDetailsByShipmentId(
|
|
@@ -223,8 +221,8 @@ class Order {
|
|
|
223
221
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
224
222
|
* @returns {Promise<OrderApplicationModel.OrderById>} - Success response
|
|
225
223
|
* @name getOrderById
|
|
226
|
-
* @summary:
|
|
227
|
-
* @description: Retrieve order details such as tracking details, shipment, store information using Fynd Order ID
|
|
224
|
+
* @summary: Get a order
|
|
225
|
+
* @description: Retrieve order details such as tracking details, shipment, store information using Fynd Order ID - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getOrderById/).
|
|
228
226
|
*/
|
|
229
227
|
async getOrderById(
|
|
230
228
|
{ orderId, allowInactive, requestHeaders } = { requestHeaders: {} },
|
|
@@ -302,8 +300,8 @@ class Order {
|
|
|
302
300
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
303
301
|
* @returns {Promise<OrderApplicationModel.OrderList>} - Success response
|
|
304
302
|
* @name getOrders
|
|
305
|
-
* @summary:
|
|
306
|
-
* @description: Retrieves all orders associated with a customer account
|
|
303
|
+
* @summary: List customer orders
|
|
304
|
+
* @description: Retrieves all orders associated with a customer account - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getOrders/).
|
|
307
305
|
*/
|
|
308
306
|
async getOrders(
|
|
309
307
|
{
|
|
@@ -412,92 +410,14 @@ class Order {
|
|
|
412
410
|
return response;
|
|
413
411
|
}
|
|
414
412
|
|
|
415
|
-
/**
|
|
416
|
-
* @param {OrderApplicationValidator.GetPosOrderByIdParam} arg - Arg object.
|
|
417
|
-
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
418
|
-
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
419
|
-
* @returns {Promise<OrderApplicationModel.OrderById>} - Success response
|
|
420
|
-
* @name getPosOrderById
|
|
421
|
-
* @summary: Retrieves POS order details
|
|
422
|
-
* @description: Retrieve a POS order and all its details such as tracking details, shipment, store information using Fynd Order ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getPosOrderById/).
|
|
423
|
-
*/
|
|
424
|
-
async getPosOrderById(
|
|
425
|
-
{ orderId, requestHeaders } = { requestHeaders: {} },
|
|
426
|
-
{ responseHeaders } = { responseHeaders: false }
|
|
427
|
-
) {
|
|
428
|
-
const { error } = OrderApplicationValidator.getPosOrderById().validate(
|
|
429
|
-
{ orderId },
|
|
430
|
-
{ abortEarly: false, allowUnknown: true }
|
|
431
|
-
);
|
|
432
|
-
if (error) {
|
|
433
|
-
return Promise.reject(new FDKClientValidationError(error));
|
|
434
|
-
}
|
|
435
|
-
|
|
436
|
-
// Showing warrnings if extra unknown parameters are found
|
|
437
|
-
const {
|
|
438
|
-
error: warrning,
|
|
439
|
-
} = OrderApplicationValidator.getPosOrderById().validate(
|
|
440
|
-
{ orderId },
|
|
441
|
-
{ abortEarly: false, allowUnknown: false }
|
|
442
|
-
);
|
|
443
|
-
if (warrning) {
|
|
444
|
-
Logger({
|
|
445
|
-
level: "WARN",
|
|
446
|
-
message: `Parameter Validation warrnings for application > Order > getPosOrderById \n ${warrning}`,
|
|
447
|
-
});
|
|
448
|
-
}
|
|
449
|
-
|
|
450
|
-
const query_params = {};
|
|
451
|
-
|
|
452
|
-
const xHeaders = {};
|
|
453
|
-
|
|
454
|
-
const response = await ApplicationAPIClient.execute(
|
|
455
|
-
this._conf,
|
|
456
|
-
"get",
|
|
457
|
-
constructUrl({
|
|
458
|
-
url: this._urls["getPosOrderById"],
|
|
459
|
-
params: { orderId },
|
|
460
|
-
}),
|
|
461
|
-
query_params,
|
|
462
|
-
undefined,
|
|
463
|
-
{ ...xHeaders, ...requestHeaders },
|
|
464
|
-
{ responseHeaders }
|
|
465
|
-
);
|
|
466
|
-
|
|
467
|
-
let responseData = response;
|
|
468
|
-
if (responseHeaders) {
|
|
469
|
-
responseData = response[0];
|
|
470
|
-
}
|
|
471
|
-
|
|
472
|
-
const {
|
|
473
|
-
error: res_error,
|
|
474
|
-
} = OrderApplicationModel.OrderById().validate(responseData, {
|
|
475
|
-
abortEarly: false,
|
|
476
|
-
allowUnknown: true,
|
|
477
|
-
});
|
|
478
|
-
|
|
479
|
-
if (res_error) {
|
|
480
|
-
if (this._conf.options.strictResponseCheck === true) {
|
|
481
|
-
return Promise.reject(new FDKResponseValidationError(res_error));
|
|
482
|
-
} else {
|
|
483
|
-
Logger({
|
|
484
|
-
level: "WARN",
|
|
485
|
-
message: `Response Validation Warnings for application > Order > getPosOrderById \n ${res_error}`,
|
|
486
|
-
});
|
|
487
|
-
}
|
|
488
|
-
}
|
|
489
|
-
|
|
490
|
-
return response;
|
|
491
|
-
}
|
|
492
|
-
|
|
493
413
|
/**
|
|
494
414
|
* @param {OrderApplicationValidator.GetShipmentBagReasonsParam} arg - Arg object.
|
|
495
415
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
496
416
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
497
417
|
* @returns {Promise<OrderApplicationModel.ShipmentBagReasons>} - Success response
|
|
498
418
|
* @name getShipmentBagReasons
|
|
499
|
-
* @summary:
|
|
500
|
-
* @description:
|
|
419
|
+
* @summary: List bag cancellation reasons
|
|
420
|
+
* @description: Get reasons to perform full or partial cancellation of a bag - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentBagReasons/).
|
|
501
421
|
*/
|
|
502
422
|
async getShipmentBagReasons(
|
|
503
423
|
{ shipmentId, bagId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -576,7 +496,7 @@ class Order {
|
|
|
576
496
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
577
497
|
* @returns {Promise<OrderApplicationModel.ShipmentById>} - Success response
|
|
578
498
|
* @name getShipmentById
|
|
579
|
-
* @summary:
|
|
499
|
+
* @summary: Get a Shipment
|
|
580
500
|
* @description: Retrieve shipment details such as price breakup, tracking details, store information, etc. using Shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentById/).
|
|
581
501
|
*/
|
|
582
502
|
async getShipmentById(
|
|
@@ -655,8 +575,8 @@ class Order {
|
|
|
655
575
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
656
576
|
* @returns {Promise<OrderApplicationModel.ShipmentReasons>} - Success response
|
|
657
577
|
* @name getShipmentReasons
|
|
658
|
-
* @summary:
|
|
659
|
-
* @description:
|
|
578
|
+
* @summary: List shipment cancellation reasons
|
|
579
|
+
* @description: Get reasons to perform full or partial cancellation of a shipment - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/getShipmentReasons/).
|
|
660
580
|
*/
|
|
661
581
|
async getShipmentReasons(
|
|
662
582
|
{ shipmentId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -734,8 +654,8 @@ class Order {
|
|
|
734
654
|
* @returns {Promise<OrderApplicationModel.SendOtpToCustomerResponse>} -
|
|
735
655
|
* Success response
|
|
736
656
|
* @name sendOtpToShipmentCustomer
|
|
737
|
-
* @summary:
|
|
738
|
-
* @description: Sends a one-time password (OTP) to the customer for shipment verification
|
|
657
|
+
* @summary: Send OTP to customer
|
|
658
|
+
* @description: Sends a one-time password (OTP) to the customer for shipment verification - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/sendOtpToShipmentCustomer/).
|
|
739
659
|
*/
|
|
740
660
|
async sendOtpToShipmentCustomer(
|
|
741
661
|
{ orderId, shipmentId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -814,7 +734,7 @@ class Order {
|
|
|
814
734
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
815
735
|
* @returns {Promise<OrderApplicationModel.ShipmentTrack>} - Success response
|
|
816
736
|
* @name trackShipment
|
|
817
|
-
* @summary:
|
|
737
|
+
* @summary: Track shipment status
|
|
818
738
|
* @description: Track Shipment by shipment id, for application based on application Id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/trackShipment/).
|
|
819
739
|
*/
|
|
820
740
|
async trackShipment(
|
|
@@ -895,7 +815,7 @@ class Order {
|
|
|
895
815
|
*
|
|
896
816
|
* @name updateShipmentStatus
|
|
897
817
|
* @summary: Updates shipment status
|
|
898
|
-
* @description: Modifies the current status of a specific shipment using its shipment ID. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/updateShipmentStatus/).
|
|
818
|
+
* @description: Modifies the current status of a specific shipment using its shipment ID. Supports both partial and full transition as per the configured settings. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/order/updateShipmentStatus/).
|
|
899
819
|
*/
|
|
900
820
|
async updateShipmentStatus(
|
|
901
821
|
{ shipmentId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -34,11 +34,6 @@ export = OrderApplicationValidator;
|
|
|
34
34
|
* @property {boolean} [allowInactive] - Flag indicating whether inactive
|
|
35
35
|
* shipments are allowed
|
|
36
36
|
*/
|
|
37
|
-
/**
|
|
38
|
-
* @typedef GetPosOrderByIdParam
|
|
39
|
-
* @property {string} orderId - A unique number used for identifying and
|
|
40
|
-
* tracking your orders.
|
|
41
|
-
*/
|
|
42
37
|
/**
|
|
43
38
|
* @typedef GetShipmentBagReasonsParam
|
|
44
39
|
* @property {string} shipmentId - ID of the bag. An order may contain multiple
|
|
@@ -98,8 +93,6 @@ declare class OrderApplicationValidator {
|
|
|
98
93
|
static getOrderById(): GetOrderByIdParam;
|
|
99
94
|
/** @returns {GetOrdersParam} */
|
|
100
95
|
static getOrders(): GetOrdersParam;
|
|
101
|
-
/** @returns {GetPosOrderByIdParam} */
|
|
102
|
-
static getPosOrderById(): GetPosOrderByIdParam;
|
|
103
96
|
/** @returns {GetShipmentBagReasonsParam} */
|
|
104
97
|
static getShipmentBagReasons(): GetShipmentBagReasonsParam;
|
|
105
98
|
/** @returns {GetShipmentByIdParam} */
|
|
@@ -116,7 +109,7 @@ declare class OrderApplicationValidator {
|
|
|
116
109
|
static verifyOtpShipmentCustomer(): VerifyOtpShipmentCustomerParam;
|
|
117
110
|
}
|
|
118
111
|
declare namespace OrderApplicationValidator {
|
|
119
|
-
export { GetCustomerDetailsByShipmentIdParam, GetInvoiceByShipmentIdParam, GetOrderByIdParam, GetOrdersParam,
|
|
112
|
+
export { GetCustomerDetailsByShipmentIdParam, GetInvoiceByShipmentIdParam, GetOrderByIdParam, GetOrdersParam, GetShipmentBagReasonsParam, GetShipmentByIdParam, GetShipmentReasonsParam, SendOtpToShipmentCustomerParam, TrackShipmentParam, UpdateShipmentStatusParam, VerifyOtpShipmentCustomerParam };
|
|
120
113
|
}
|
|
121
114
|
type GetCustomerDetailsByShipmentIdParam = {
|
|
122
115
|
/**
|
|
@@ -191,13 +184,6 @@ type GetOrdersParam = {
|
|
|
191
184
|
*/
|
|
192
185
|
allowInactive?: boolean;
|
|
193
186
|
};
|
|
194
|
-
type GetPosOrderByIdParam = {
|
|
195
|
-
/**
|
|
196
|
-
* - A unique number used for identifying and
|
|
197
|
-
* tracking your orders.
|
|
198
|
-
*/
|
|
199
|
-
orderId: string;
|
|
200
|
-
};
|
|
201
187
|
type GetShipmentBagReasonsParam = {
|
|
202
188
|
/**
|
|
203
189
|
* - ID of the bag. An order may contain multiple
|
|
@@ -41,12 +41,6 @@ const OrderApplicationModel = require("./OrderApplicationModel");
|
|
|
41
41
|
* shipments are allowed
|
|
42
42
|
*/
|
|
43
43
|
|
|
44
|
-
/**
|
|
45
|
-
* @typedef GetPosOrderByIdParam
|
|
46
|
-
* @property {string} orderId - A unique number used for identifying and
|
|
47
|
-
* tracking your orders.
|
|
48
|
-
*/
|
|
49
|
-
|
|
50
44
|
/**
|
|
51
45
|
* @typedef GetShipmentBagReasonsParam
|
|
52
46
|
* @property {string} shipmentId - ID of the bag. An order may contain multiple
|
|
@@ -143,13 +137,6 @@ class OrderApplicationValidator {
|
|
|
143
137
|
});
|
|
144
138
|
}
|
|
145
139
|
|
|
146
|
-
/** @returns {GetPosOrderByIdParam} */
|
|
147
|
-
static getPosOrderById() {
|
|
148
|
-
return Joi.object({
|
|
149
|
-
orderId: Joi.string().allow("").required(),
|
|
150
|
-
}).required();
|
|
151
|
-
}
|
|
152
|
-
|
|
153
140
|
/** @returns {GetShipmentBagReasonsParam} */
|
|
154
141
|
static getShipmentBagReasons() {
|
|
155
142
|
return Joi.object({
|