@gofynd/fdk-client-javascript 1.4.3 → 1.4.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -10
- package/application.d.ts +3 -3
- package/common.d.ts +3 -3
- package/index.d.ts +15 -15
- package/package.json +1 -1
- package/partner.d.ts +3 -3
- package/platform.d.ts +3 -3
- package/public.d.ts +2 -2
- package/sdk/application/ApplicationAPIClient.d.ts +1 -1
- package/sdk/application/ApplicationClient.d.ts +17 -17
- package/sdk/application/ApplicationConfig.d.ts +3 -3
- package/sdk/application/Cart/CartApplicationClient.d.ts +50 -50
- package/sdk/application/Cart/CartApplicationClient.js +48 -48
- package/sdk/application/Cart/CartApplicationValidator.d.ts +1 -1
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +72 -72
- package/sdk/application/Catalog/CatalogApplicationClient.js +69 -69
- package/sdk/application/Common/CommonApplicationClient.d.ts +6 -6
- package/sdk/application/Common/CommonApplicationClient.js +4 -4
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +8 -8
- package/sdk/application/Communication/CommunicationApplicationClient.js +6 -6
- package/sdk/application/Communication/CommunicationApplicationValidator.d.ts +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +34 -34
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +32 -32
- package/sdk/application/Configuration/ConfigurationApplicationValidator.d.ts +1 -1
- package/sdk/application/Content/ContentApplicationClient.d.ts +48 -48
- package/sdk/application/Content/ContentApplicationClient.js +45 -45
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +7 -7
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +5 -5
- package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts +1 -1
- package/sdk/application/Lead/LeadApplicationClient.d.ts +11 -11
- package/sdk/application/Lead/LeadApplicationClient.js +9 -9
- package/sdk/application/Lead/LeadApplicationValidator.d.ts +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +24 -24
- package/sdk/application/Logistic/LogisticApplicationClient.js +22 -22
- package/sdk/application/Logistic/LogisticApplicationValidator.d.ts +1 -1
- package/sdk/application/Order/OrderApplicationClient.d.ts +16 -27
- package/sdk/application/Order/OrderApplicationClient.js +14 -94
- package/sdk/application/Order/OrderApplicationValidator.d.ts +2 -16
- package/sdk/application/Order/OrderApplicationValidator.js +0 -13
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +73 -73
- package/sdk/application/Payment/PaymentApplicationClient.js +71 -71
- package/sdk/application/Payment/PaymentApplicationValidator.d.ts +1 -1
- package/sdk/application/PosCart/PosCartApplicationClient.d.ts +2 -2
- package/sdk/application/PosCart/PosCartApplicationValidator.d.ts +1 -1
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +3 -3
- package/sdk/application/Rewards/RewardsApplicationClient.js +1 -1
- package/sdk/application/Rewards/RewardsApplicationValidator.d.ts +1 -1
- package/sdk/application/Share/ShareApplicationClient.d.ts +3 -3
- package/sdk/application/Share/ShareApplicationClient.js +1 -1
- package/sdk/application/Share/ShareApplicationValidator.d.ts +1 -1
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +10 -10
- package/sdk/application/Theme/ThemeApplicationClient.js +8 -8
- package/sdk/application/User/UserApplicationClient.d.ts +76 -76
- package/sdk/application/User/UserApplicationClient.js +74 -74
- package/sdk/application/User/UserApplicationValidator.d.ts +1 -1
- package/sdk/application/index.d.ts +18 -18
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +1 -1
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +1 -1
- package/sdk/partner/OAuthClient.d.ts +4 -4
- package/sdk/partner/PartnerAPIClient.d.ts +1 -1
- package/sdk/partner/PartnerClient.d.ts +6 -6
- package/sdk/partner/PartnerConfig.d.ts +4 -4
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +1 -1
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +1 -1
- package/sdk/partner/index.d.ts +7 -7
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +7 -7
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +5 -5
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -1
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +15 -15
- package/sdk/platform/Billing/BillingPlatformClient.js +13 -13
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +1 -1
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +104 -104
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +102 -102
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +135 -134
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +132 -131
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +133 -133
- package/sdk/platform/Catalog/CatalogPlatformClient.js +130 -130
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +1 -1
- package/sdk/platform/Common/CommonPlatformClient.d.ts +4 -4
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +120 -120
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +118 -118
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +3 -3
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +25 -25
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +22 -22
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +43 -43
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +41 -41
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +28 -28
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +26 -26
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +96 -96
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +93 -93
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Content/ContentPlatformClient.d.ts +31 -31
- package/sdk/platform/Content/ContentPlatformClient.js +29 -29
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +1 -1
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +20 -20
- package/sdk/platform/Discount/DiscountPlatformClient.js +18 -18
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +20 -19
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +18 -17
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +8 -8
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +1 -1
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +6 -6
- package/sdk/platform/Finance/FinancePlatformClient.js +4 -4
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +1 -1
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +14 -14
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +12 -12
- package/sdk/platform/Lead/LeadPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +17 -17
- package/sdk/platform/Lead/LeadPlatformClient.js +15 -15
- package/sdk/platform/Lead/LeadPlatformValidator.d.ts +1 -1
- package/sdk/platform/OAuthClient.d.ts +3 -3
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +10 -10
- package/sdk/platform/Order/OrderPlatformClient.d.ts +97 -108
- 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 +2 -34
- package/sdk/platform/Order/OrderPlatformValidator.js +0 -20
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +4 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +79 -79
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +77 -77
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +4 -4
- 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/Payment/PaymentPlatformValidator.d.ts +1 -1
- package/sdk/platform/PlatformAPIClient.d.ts +1 -1
- package/sdk/platform/PlatformApplicationClient.d.ts +16 -16
- package/sdk/platform/PlatformClient.d.ts +19 -21
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/PlatformConfig.d.ts +4 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +7 -7
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +42 -42
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +40 -40
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +53 -52
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +51 -50
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +1 -1
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Share/SharePlatformApplicationClient.js +1 -1
- package/sdk/platform/Share/SharePlatformApplicationValidator.d.ts +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 +36 -106
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +34 -591
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +2 -101
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +0 -92
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +8 -8
- package/sdk/platform/Theme/ThemePlatformClient.js +6 -6
- package/sdk/platform/Theme/ThemePlatformValidator.d.ts +1 -1
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +37 -37
- package/sdk/platform/User/UserPlatformApplicationClient.js +35 -35
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +1 -1
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -8
- package/sdk/platform/Webhook/WebhookPlatformClient.js +7 -6
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +1 -1
- package/sdk/platform/index.d.ts +24 -25
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Billing/BillingPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Content/ContentPublicClient.d.ts +2 -2
- package/sdk/public/Inventory/InventoryPublicClient.d.ts +2 -2
- package/sdk/public/Inventory/InventoryPublicValidator.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.d.ts +2 -2
- package/sdk/public/PublicAPIClient.d.ts +1 -1
- package/sdk/public/PublicClient.d.ts +7 -7
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +2 -2
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +1 -1
- package/sdk/public/index.d.ts +8 -8
- 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
|
@@ -19,7 +19,7 @@ declare class Lead {
|
|
|
19
19
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
20
20
|
* @returns {Promise<LeadApplicationModel.TicketHistory>} - Success response
|
|
21
21
|
* @name createHistory
|
|
22
|
-
* @summary:
|
|
22
|
+
* @summary: Log ticket history
|
|
23
23
|
* @description: Adds a history entry for a specific support ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/createHistory/).
|
|
24
24
|
*/
|
|
25
25
|
createHistory({ id, body, requestHeaders }?: LeadApplicationValidator.CreateHistoryParam, { responseHeaders }?: object): Promise<LeadApplicationModel.TicketHistory>;
|
|
@@ -29,7 +29,7 @@ declare class Lead {
|
|
|
29
29
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
30
30
|
* @returns {Promise<LeadApplicationModel.Ticket>} - Success response
|
|
31
31
|
* @name createTicket
|
|
32
|
-
* @summary: Creates a
|
|
32
|
+
* @summary: Creates a ticket
|
|
33
33
|
* @description: Generates a new customer support ticket for a user query. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/createTicket/).
|
|
34
34
|
*/
|
|
35
35
|
createTicket({ body, requestHeaders }?: LeadApplicationValidator.CreateTicketParam, { responseHeaders }?: object): Promise<LeadApplicationModel.Ticket>;
|
|
@@ -39,8 +39,8 @@ declare class Lead {
|
|
|
39
39
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
40
40
|
* @returns {Promise<LeadApplicationModel.CustomForm>} - Success response
|
|
41
41
|
* @name getCustomForm
|
|
42
|
-
* @summary:
|
|
43
|
-
* @description:
|
|
42
|
+
* @summary: Get custom form
|
|
43
|
+
* @description: Get a customizable form template for data collection. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getCustomForm/).
|
|
44
44
|
*/
|
|
45
45
|
getCustomForm({ slug, requestHeaders }?: LeadApplicationValidator.GetCustomFormParam, { responseHeaders }?: object): Promise<LeadApplicationModel.CustomForm>;
|
|
46
46
|
/**
|
|
@@ -53,7 +53,7 @@ declare class Lead {
|
|
|
53
53
|
* - Success response
|
|
54
54
|
*
|
|
55
55
|
* @name getParticipantsInsideVideoRoom
|
|
56
|
-
* @summary:
|
|
56
|
+
* @summary: List video room participants
|
|
57
57
|
* @description: Gets the current participants inside a specific video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getParticipantsInsideVideoRoom/).
|
|
58
58
|
*/
|
|
59
59
|
getParticipantsInsideVideoRoom({ uniqueName, requestHeaders }?: LeadApplicationValidator.GetParticipantsInsideVideoRoomParam, { responseHeaders }?: object): Promise<LeadApplicationModel.GetParticipantsInsideVideoRoomResponse>;
|
|
@@ -63,8 +63,8 @@ declare class Lead {
|
|
|
63
63
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
64
64
|
* @returns {Promise<LeadApplicationModel.Ticket>} - Success response
|
|
65
65
|
* @name getTicket
|
|
66
|
-
* @summary:
|
|
67
|
-
* @description:
|
|
66
|
+
* @summary: Get a support ticket
|
|
67
|
+
* @description: Get details of a specific customer support ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getTicket/).
|
|
68
68
|
*/
|
|
69
69
|
getTicket({ id, requestHeaders }?: LeadApplicationValidator.GetTicketParam, { responseHeaders }?: object): Promise<LeadApplicationModel.Ticket>;
|
|
70
70
|
/**
|
|
@@ -74,8 +74,8 @@ declare class Lead {
|
|
|
74
74
|
* @returns {Promise<LeadApplicationModel.GetTokenForVideoRoomResponse>} -
|
|
75
75
|
* Success response
|
|
76
76
|
* @name getTokenForVideoRoom
|
|
77
|
-
* @summary:
|
|
78
|
-
* @description:
|
|
77
|
+
* @summary: Get video room token
|
|
78
|
+
* @description: Get a secure token for accessing a video chat room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getTokenForVideoRoom/).
|
|
79
79
|
*/
|
|
80
80
|
getTokenForVideoRoom({ uniqueName, requestHeaders }?: LeadApplicationValidator.GetTokenForVideoRoomParam, { responseHeaders }?: object): Promise<LeadApplicationModel.GetTokenForVideoRoomResponse>;
|
|
81
81
|
/**
|
|
@@ -90,5 +90,5 @@ declare class Lead {
|
|
|
90
90
|
*/
|
|
91
91
|
submitCustomForm({ slug, body, requestHeaders }?: LeadApplicationValidator.SubmitCustomFormParam, { responseHeaders }?: object): Promise<LeadApplicationModel.SubmitCustomFormResponse>;
|
|
92
92
|
}
|
|
93
|
-
import LeadApplicationValidator = require("
|
|
94
|
-
import LeadApplicationModel = require("
|
|
93
|
+
import LeadApplicationValidator = require("sdk/output/javascript/code/sdk/application/Lead/LeadApplicationValidator");
|
|
94
|
+
import LeadApplicationModel = require("sdk/output/javascript/code/sdk/application/Lead/LeadApplicationModel");
|
|
@@ -46,7 +46,7 @@ class Lead {
|
|
|
46
46
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
47
47
|
* @returns {Promise<LeadApplicationModel.TicketHistory>} - Success response
|
|
48
48
|
* @name createHistory
|
|
49
|
-
* @summary:
|
|
49
|
+
* @summary: Log ticket history
|
|
50
50
|
* @description: Adds a history entry for a specific support ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/createHistory/).
|
|
51
51
|
*/
|
|
52
52
|
async createHistory(
|
|
@@ -124,7 +124,7 @@ class Lead {
|
|
|
124
124
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
125
125
|
* @returns {Promise<LeadApplicationModel.Ticket>} - Success response
|
|
126
126
|
* @name createTicket
|
|
127
|
-
* @summary: Creates a
|
|
127
|
+
* @summary: Creates a ticket
|
|
128
128
|
* @description: Generates a new customer support ticket for a user query. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/createTicket/).
|
|
129
129
|
*/
|
|
130
130
|
async createTicket(
|
|
@@ -202,8 +202,8 @@ class Lead {
|
|
|
202
202
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
203
203
|
* @returns {Promise<LeadApplicationModel.CustomForm>} - Success response
|
|
204
204
|
* @name getCustomForm
|
|
205
|
-
* @summary:
|
|
206
|
-
* @description:
|
|
205
|
+
* @summary: Get custom form
|
|
206
|
+
* @description: Get a customizable form template for data collection. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getCustomForm/).
|
|
207
207
|
*/
|
|
208
208
|
async getCustomForm(
|
|
209
209
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -284,7 +284,7 @@ class Lead {
|
|
|
284
284
|
* - Success response
|
|
285
285
|
*
|
|
286
286
|
* @name getParticipantsInsideVideoRoom
|
|
287
|
-
* @summary:
|
|
287
|
+
* @summary: List video room participants
|
|
288
288
|
* @description: Gets the current participants inside a specific video room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getParticipantsInsideVideoRoom/).
|
|
289
289
|
*/
|
|
290
290
|
async getParticipantsInsideVideoRoom(
|
|
@@ -364,8 +364,8 @@ class Lead {
|
|
|
364
364
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
365
365
|
* @returns {Promise<LeadApplicationModel.Ticket>} - Success response
|
|
366
366
|
* @name getTicket
|
|
367
|
-
* @summary:
|
|
368
|
-
* @description:
|
|
367
|
+
* @summary: Get a support ticket
|
|
368
|
+
* @description: Get details of a specific customer support ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getTicket/).
|
|
369
369
|
*/
|
|
370
370
|
async getTicket(
|
|
371
371
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -441,8 +441,8 @@ class Lead {
|
|
|
441
441
|
* @returns {Promise<LeadApplicationModel.GetTokenForVideoRoomResponse>} -
|
|
442
442
|
* Success response
|
|
443
443
|
* @name getTokenForVideoRoom
|
|
444
|
-
* @summary:
|
|
445
|
-
* @description:
|
|
444
|
+
* @summary: Get video room token
|
|
445
|
+
* @description: Get a secure token for accessing a video chat room. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getTokenForVideoRoom/).
|
|
446
446
|
*/
|
|
447
447
|
async getTokenForVideoRoom(
|
|
448
448
|
{ uniqueName, requestHeaders } = { requestHeaders: {} },
|
|
@@ -89,4 +89,4 @@ type SubmitCustomFormParam = {
|
|
|
89
89
|
slug: string;
|
|
90
90
|
body: LeadApplicationModel.CustomFormSubmissionPayload;
|
|
91
91
|
};
|
|
92
|
-
import LeadApplicationModel = require("
|
|
92
|
+
import LeadApplicationModel = require("sdk/output/javascript/code/sdk/application/Lead/LeadApplicationModel");
|
|
@@ -23,8 +23,8 @@ declare class Logistic {
|
|
|
23
23
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
24
24
|
* @returns {Promise<LogisticApplicationModel.CountryListResponse>} - Success response
|
|
25
25
|
* @name getAllCountries
|
|
26
|
-
* @summary:
|
|
27
|
-
* @description:
|
|
26
|
+
* @summary: Get deliverable countries
|
|
27
|
+
* @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/).
|
|
28
28
|
*/
|
|
29
29
|
getAllCountries({ requestHeaders }?: any, { responseHeaders }?: object): Promise<LogisticApplicationModel.CountryListResponse>;
|
|
30
30
|
/**
|
|
@@ -33,8 +33,8 @@ declare class Logistic {
|
|
|
33
33
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
34
34
|
* @returns {Promise<LogisticApplicationModel.GetCountries>} - Success response
|
|
35
35
|
* @name getCountries
|
|
36
|
-
* @summary: Get
|
|
37
|
-
* @description:
|
|
36
|
+
* @summary: Get countries
|
|
37
|
+
* @description: Fetch the list of supported countries. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCountries/).
|
|
38
38
|
*/
|
|
39
39
|
getCountries({ onboarding, pageNo, pageSize, q, requestHeaders }?: LogisticApplicationValidator.GetCountriesParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.GetCountries>;
|
|
40
40
|
/**
|
|
@@ -43,8 +43,8 @@ declare class Logistic {
|
|
|
43
43
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
44
44
|
* @returns {Promise<LogisticApplicationModel.GetCountry>} - Success response
|
|
45
45
|
* @name getCountry
|
|
46
|
-
* @summary: Get
|
|
47
|
-
* @description:
|
|
46
|
+
* @summary: Get country details
|
|
47
|
+
* @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/).
|
|
48
48
|
*/
|
|
49
49
|
getCountry({ countryIsoCode, requestHeaders }?: LogisticApplicationValidator.GetCountryParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.GetCountry>;
|
|
50
50
|
/**
|
|
@@ -53,8 +53,8 @@ declare class Logistic {
|
|
|
53
53
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
54
54
|
* @returns {Promise<LogisticApplicationModel.GetLocalities>} - Success response
|
|
55
55
|
* @name getLocalities
|
|
56
|
-
* @summary: Get
|
|
57
|
-
* @description:
|
|
56
|
+
* @summary: Get localities
|
|
57
|
+
* @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/).
|
|
58
58
|
*/
|
|
59
59
|
getLocalities({ localityType, country, state, city, pageNo, pageSize, q, requestHeaders, }?: LogisticApplicationValidator.GetLocalitiesParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.GetLocalities>;
|
|
60
60
|
/**
|
|
@@ -63,8 +63,8 @@ declare class Logistic {
|
|
|
63
63
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
64
64
|
* @returns {Promise<LogisticApplicationModel.GetLocality>} - Success response
|
|
65
65
|
* @name getLocality
|
|
66
|
-
* @summary: Get
|
|
67
|
-
* @description:
|
|
66
|
+
* @summary: Get locality detail
|
|
67
|
+
* @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/).
|
|
68
68
|
*/
|
|
69
69
|
getLocality({ localityType, localityValue, country, state, city, requestHeaders }?: LogisticApplicationValidator.GetLocalityParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.GetLocality>;
|
|
70
70
|
/**
|
|
@@ -73,8 +73,8 @@ declare class Logistic {
|
|
|
73
73
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
74
74
|
* @returns {Promise<LogisticApplicationModel.GetStoreResponse>} - Success response
|
|
75
75
|
* @name getLocations
|
|
76
|
-
* @summary:
|
|
77
|
-
* @description: Retrieves
|
|
76
|
+
* @summary: Get available selling locations
|
|
77
|
+
* @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/).
|
|
78
78
|
*/
|
|
79
79
|
getLocations({ xApplicationId, xApplicationData, country, state, city, pincode, sector, pageNo, pageSize, requestHeaders, }?: LogisticApplicationValidator.GetLocationsParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.GetStoreResponse>;
|
|
80
80
|
/**
|
|
@@ -84,8 +84,8 @@ declare class Logistic {
|
|
|
84
84
|
* @returns {Promise<LogisticApplicationModel.ReAssignStoreResponse>} -
|
|
85
85
|
* Success response
|
|
86
86
|
* @name getOptimalLocations
|
|
87
|
-
* @summary:
|
|
88
|
-
* @description:
|
|
87
|
+
* @summary: Get selling locations
|
|
88
|
+
* @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/).
|
|
89
89
|
*/
|
|
90
90
|
getOptimalLocations({ body, requestHeaders }?: LogisticApplicationValidator.GetOptimalLocationsParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.ReAssignStoreResponse>;
|
|
91
91
|
/**
|
|
@@ -94,8 +94,8 @@ declare class Logistic {
|
|
|
94
94
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
95
95
|
* @returns {Promise<LogisticApplicationModel.PincodeApiResponse>} - Success response
|
|
96
96
|
* @name getPincodeCity
|
|
97
|
-
* @summary:
|
|
98
|
-
* @description: Retrieve
|
|
97
|
+
* @summary: Get pincode details
|
|
98
|
+
* @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/).
|
|
99
99
|
*/
|
|
100
100
|
getPincodeCity({ pincode, requestHeaders }?: LogisticApplicationValidator.GetPincodeCityParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.PincodeApiResponse>;
|
|
101
101
|
/**
|
|
@@ -106,8 +106,8 @@ declare class Logistic {
|
|
|
106
106
|
* - Success response
|
|
107
107
|
*
|
|
108
108
|
* @name getPincodeZones
|
|
109
|
-
* @summary:
|
|
110
|
-
* @description:
|
|
109
|
+
* @summary: Get zones
|
|
110
|
+
* @description: Retrieve the delivery zone associated with a given pincode - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeZones/).
|
|
111
111
|
*/
|
|
112
112
|
getPincodeZones({ body, requestHeaders }?: LogisticApplicationValidator.GetPincodeZonesParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.GetZoneFromPincodeViewResponse>;
|
|
113
113
|
/**
|
|
@@ -116,8 +116,8 @@ declare class Logistic {
|
|
|
116
116
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
117
117
|
* @returns {Promise<LogisticApplicationModel.TATViewResponse>} - Success response
|
|
118
118
|
* @name getTatProduct
|
|
119
|
-
* @summary:
|
|
120
|
-
* @description: Retrieve the estimated delivery
|
|
119
|
+
* @summary: Get product's turnaround time
|
|
120
|
+
* @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/).
|
|
121
121
|
*/
|
|
122
122
|
getTatProduct({ body, requestHeaders }?: LogisticApplicationValidator.GetTatProductParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.TATViewResponse>;
|
|
123
123
|
/**
|
|
@@ -127,10 +127,10 @@ declare class Logistic {
|
|
|
127
127
|
* @returns {Promise<LogisticApplicationModel.ValidateAddressRequest>} -
|
|
128
128
|
* Success response
|
|
129
129
|
* @name validateAddress
|
|
130
|
-
* @summary: Validate
|
|
131
|
-
* @description: Validate
|
|
130
|
+
* @summary: Validate address
|
|
131
|
+
* @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/).
|
|
132
132
|
*/
|
|
133
133
|
validateAddress({ countryIsoCode, templateName, body, requestHeaders }?: LogisticApplicationValidator.ValidateAddressParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.ValidateAddressRequest>;
|
|
134
134
|
}
|
|
135
|
-
import LogisticApplicationModel = require("
|
|
136
|
-
import LogisticApplicationValidator = require("
|
|
135
|
+
import LogisticApplicationModel = require("sdk/output/javascript/code/sdk/application/Logistic/LogisticApplicationModel");
|
|
136
|
+
import LogisticApplicationValidator = require("sdk/output/javascript/code/sdk/application/Logistic/LogisticApplicationValidator");
|
|
@@ -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 } = {
|
|
@@ -257,4 +257,4 @@ type ValidateAddressParam = {
|
|
|
257
257
|
body: LogisticApplicationModel.ValidateAddressRequest;
|
|
258
258
|
};
|
|
259
259
|
type GetAllCountriesParam = any;
|
|
260
|
-
import LogisticApplicationModel = require("
|
|
260
|
+
import LogisticApplicationModel = require("sdk/output/javascript/code/sdk/application/Logistic/LogisticApplicationModel");
|
|
@@ -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
|
/**
|
|
@@ -146,5 +135,5 @@ declare class Order {
|
|
|
146
135
|
*/
|
|
147
136
|
verifyOtpShipmentCustomer({ orderId, shipmentId, body, requestHeaders }?: OrderApplicationValidator.VerifyOtpShipmentCustomerParam, { responseHeaders }?: object): Promise<OrderApplicationModel.VerifyOtpResponse>;
|
|
148
137
|
}
|
|
149
|
-
import OrderApplicationValidator = require("
|
|
150
|
-
import OrderApplicationModel = require("
|
|
138
|
+
import OrderApplicationValidator = require("sdk/output/javascript/code/sdk/application/Order/OrderApplicationValidator");
|
|
139
|
+
import OrderApplicationModel = require("sdk/output/javascript/code/sdk/application/Order/OrderApplicationModel");
|