@gofynd/fdk-client-javascript 3.3.5 → 3.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/Cart/CartApplicationClient.d.ts +30 -30
- package/sdk/application/Cart/CartApplicationClient.js +30 -30
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +36 -33
- package/sdk/application/Catalog/CatalogApplicationClient.js +54 -35
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +2 -2
- package/sdk/application/Communication/CommunicationApplicationClient.d.ts +3 -3
- package/sdk/application/Communication/CommunicationApplicationClient.js +3 -3
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +16 -16
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +16 -16
- package/sdk/application/Content/ContentApplicationClient.d.ts +24 -24
- package/sdk/application/Content/ContentApplicationClient.js +24 -24
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +3 -3
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +3 -3
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +2 -2
- package/sdk/application/Finance/FinanceApplicationClient.js +2 -2
- package/sdk/application/Lead/LeadApplicationClient.d.ts +5 -5
- package/sdk/application/Lead/LeadApplicationClient.js +5 -5
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +19 -9
- package/sdk/application/Logistic/LogisticApplicationClient.js +53 -9
- package/sdk/application/Order/OrderApplicationClient.d.ts +12 -12
- package/sdk/application/Order/OrderApplicationClient.js +12 -12
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +46 -46
- package/sdk/application/Payment/PaymentApplicationClient.js +46 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +7 -7
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Share/ShareApplicationClient.d.ts +7 -7
- package/sdk/application/Share/ShareApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +4 -4
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -4
- package/sdk/application/User/UserApplicationClient.d.ts +47 -47
- package/sdk/application/User/UserApplicationClient.js +47 -47
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +1 -1
- package/sdk/application/Webhook/WebhookApplicationClient.js +1 -1
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +6 -6
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +6 -6
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +7 -7
- package/sdk/partner/Lead/LeadPartnerClient.js +7 -7
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.js +1 -1
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +25 -25
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +6 -6
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +3 -3
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +24 -24
- package/sdk/partner/Theme/ThemePartnerClient.js +24 -24
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +10 -10
- package/sdk/partner/Webhook/WebhookPartnerClient.js +10 -10
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +7 -2
- package/sdk/partner/Webhook/WebhookPartnerModel.js +3 -1
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +3 -3
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +2 -2
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +1 -1
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +1 -1
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +5 -5
- package/sdk/platform/Billing/BillingPlatformClient.js +5 -5
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +62 -62
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +62 -62
- package/sdk/platform/Cart/CartPlatformModel.d.ts +233 -3
- package/sdk/platform/Cart/CartPlatformModel.js +147 -1
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +66 -66
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +66 -66
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +81 -79
- package/sdk/platform/Catalog/CatalogPlatformClient.js +93 -80
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +89 -5
- package/sdk/platform/Catalog/CatalogPlatformModel.js +57 -3
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +7 -2
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +4 -2
- package/sdk/platform/Common/CommonPlatformClient.d.ts +2 -2
- package/sdk/platform/Common/CommonPlatformClient.js +2 -2
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +67 -67
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +67 -67
- package/sdk/platform/Communication/CommunicationPlatformClient.d.ts +1 -1
- package/sdk/platform/Communication/CommunicationPlatformClient.js +1 -1
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +2 -2
- package/sdk/platform/Communication/CommunicationPlatformModel.js +1 -1
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +14 -14
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +2 -2
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +1 -1
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +32 -32
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +11 -11
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +19 -3
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +16 -1
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +107 -107
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +107 -107
- package/sdk/platform/Content/ContentPlatformClient.d.ts +40 -40
- package/sdk/platform/Content/ContentPlatformClient.js +40 -40
- package/sdk/platform/Content/ContentPlatformModel.d.ts +2 -2
- package/sdk/platform/Content/ContentPlatformModel.js +1 -1
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +11 -11
- package/sdk/platform/Discount/DiscountPlatformClient.js +11 -11
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformModel.js +1 -1
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +4 -4
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +6 -6
- package/sdk/platform/Lead/LeadPlatformApplicationClient.d.ts +10 -10
- package/sdk/platform/Lead/LeadPlatformApplicationClient.js +10 -10
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +9 -9
- package/sdk/platform/Lead/LeadPlatformClient.js +9 -9
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.js +1 -1
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +5 -5
- package/sdk/platform/Order/OrderPlatformClient.d.ts +58 -58
- package/sdk/platform/Order/OrderPlatformClient.js +58 -58
- package/sdk/platform/Order/OrderPlatformModel.d.ts +29 -10
- package/sdk/platform/Order/OrderPlatformModel.js +28 -6
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +2 -2
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +51 -51
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +51 -51
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +10 -10
- package/sdk/platform/Payment/PaymentPlatformClient.js +10 -10
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +2 -2
- package/sdk/platform/Payment/PaymentPlatformModel.js +1 -1
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +12 -12
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.js +1 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +162 -39
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +840 -73
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +139 -1
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +125 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +30 -30
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +36 -30
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +936 -62
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +591 -33
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +12 -0
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +5 -0
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +5 -5
- package/sdk/platform/Share/SharePlatformApplicationClient.js +5 -5
- package/sdk/platform/Share/SharePlatformModel.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformModel.js +1 -1
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +22 -22
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +22 -22
- package/sdk/platform/Theme/ThemePlatformClient.d.ts +4 -4
- package/sdk/platform/Theme/ThemePlatformClient.js +4 -4
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +70 -34
- package/sdk/platform/User/UserPlatformApplicationClient.js +285 -34
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +38 -1
- package/sdk/platform/User/UserPlatformApplicationValidator.js +42 -0
- package/sdk/platform/User/UserPlatformModel.d.ts +430 -10
- package/sdk/platform/User/UserPlatformModel.js +276 -7
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +9 -9
- package/sdk/platform/Webhook/WebhookPlatformClient.js +9 -9
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +12 -2
- package/sdk/platform/Webhook/WebhookPlatformModel.js +5 -1
- package/sdk/public/Catalog/CatalogPublicClient.d.ts +1 -1
- package/sdk/public/Catalog/CatalogPublicClient.js +1 -1
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +2 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +2 -2
- package/sdk/public/Content/ContentPublicClient.d.ts +14 -14
- package/sdk/public/Content/ContentPublicClient.js +14 -14
- package/sdk/public/Partner/PartnerPublicClient.d.ts +1 -1
- package/sdk/public/Partner/PartnerPublicClient.js +1 -1
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +5 -5
- package/sdk/public/Webhook/WebhookPublicClient.js +5 -5
|
@@ -42,7 +42,7 @@ class FileStorage {
|
|
|
42
42
|
* @returns {Promise<FileUploadComplete>} - Success response
|
|
43
43
|
* @name completeUpload
|
|
44
44
|
* @summary: Finalizes upload process.
|
|
45
|
-
* @description: Complete the file upload and store the file details such as name, size, content type, and namespace to maintain integrity within the system's database. - Check out [method documentation](https://
|
|
45
|
+
* @description: Complete the file upload and store the file details such as name, size, content type, and namespace to maintain integrity within the system's database. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/filestorage/completeUpload/).
|
|
46
46
|
*/
|
|
47
47
|
async completeUpload(
|
|
48
48
|
{ namespace, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -88,7 +88,7 @@ class FileStorage {
|
|
|
88
88
|
* @returns {Promise<SignUrlResult>} - Success response
|
|
89
89
|
* @name signUrls
|
|
90
90
|
* @summary: Signs file URLs.
|
|
91
|
-
* @description: Generates secure, signed URLs that is valid for certain expiry time for accessing stored files. - Check out [method documentation](https://
|
|
91
|
+
* @description: Generates secure, signed URLs that is valid for certain expiry time for accessing stored files. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/filestorage/signUrls/).
|
|
92
92
|
*/
|
|
93
93
|
async signUrls(
|
|
94
94
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -125,7 +125,7 @@ class FileStorage {
|
|
|
125
125
|
* @returns {Promise<FileUpload>} - Success response
|
|
126
126
|
* @name startUpload
|
|
127
127
|
* @summary: Initiates file upload
|
|
128
|
-
* @description: Starts the process of uploading a file to storage location, and returns a signed url in response. - Check out [method documentation](https://
|
|
128
|
+
* @description: Starts the process of uploading a file to storage location, and returns a signed url in response. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/filestorage/startUpload/).
|
|
129
129
|
*/
|
|
130
130
|
async startUpload(
|
|
131
131
|
{ namespace, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -14,7 +14,7 @@ declare class Finance {
|
|
|
14
14
|
* @returns {Promise<CustomerCreditBalanceResponseSchema>} - Success response
|
|
15
15
|
* @name customerCreditBalance
|
|
16
16
|
* @summary: This API will provide customer's credit balance against phone number or email and seller*affiliate id
|
|
17
|
-
* @description: This API will provide customer's credit balance against phone number or email and seller*affiliate id - Check out [method documentation](https://
|
|
17
|
+
* @description: This API will provide customer's credit balance against phone number or email and seller*affiliate id - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/finance/customerCreditBalance/).
|
|
18
18
|
*/
|
|
19
19
|
customerCreditBalance({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CustomerCreditBalanceResponseSchema>;
|
|
20
20
|
/**
|
|
@@ -23,7 +23,7 @@ declare class Finance {
|
|
|
23
23
|
* @returns {Promise<LockUnlockResponseSchema>} - Success response
|
|
24
24
|
* @name lockUnlockCreditNote
|
|
25
25
|
* @summary: Lock or Unlock requested credit note.
|
|
26
|
-
* @description: Used to lock or unlock requested credit note. - Check out [method documentation](https://
|
|
26
|
+
* @description: Used to lock or unlock requested credit note. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/finance/lockUnlockCreditNote/).
|
|
27
27
|
*/
|
|
28
28
|
lockUnlockCreditNote({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<LockUnlockResponseSchema>;
|
|
29
29
|
}
|
|
@@ -39,7 +39,7 @@ class Finance {
|
|
|
39
39
|
* @returns {Promise<CustomerCreditBalanceResponseSchema>} - Success response
|
|
40
40
|
* @name customerCreditBalance
|
|
41
41
|
* @summary: This API will provide customer's credit balance against phone number or email and seller*affiliate id
|
|
42
|
-
* @description: This API will provide customer's credit balance against phone number or email and seller*affiliate id - Check out [method documentation](https://
|
|
42
|
+
* @description: This API will provide customer's credit balance against phone number or email and seller*affiliate id - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/finance/customerCreditBalance/).
|
|
43
43
|
*/
|
|
44
44
|
async customerCreditBalance(
|
|
45
45
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -76,7 +76,7 @@ class Finance {
|
|
|
76
76
|
* @returns {Promise<LockUnlockResponseSchema>} - Success response
|
|
77
77
|
* @name lockUnlockCreditNote
|
|
78
78
|
* @summary: Lock or Unlock requested credit note.
|
|
79
|
-
* @description: Used to lock or unlock requested credit note. - Check out [method documentation](https://
|
|
79
|
+
* @description: Used to lock or unlock requested credit note. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/finance/lockUnlockCreditNote/).
|
|
80
80
|
*/
|
|
81
81
|
async lockUnlockCreditNote(
|
|
82
82
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -17,7 +17,7 @@ declare class Lead {
|
|
|
17
17
|
* @returns {Promise<TicketHistory>} - Success response
|
|
18
18
|
* @name createHistory
|
|
19
19
|
* @summary: Log ticket history
|
|
20
|
-
* @description: Create a history entry for a specific support ticket. - Check out [method documentation](https://
|
|
20
|
+
* @description: Create a history entry for a specific support ticket. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/lead/createHistory/).
|
|
21
21
|
*/
|
|
22
22
|
createHistory({ id, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<TicketHistory>;
|
|
23
23
|
/**
|
|
@@ -26,7 +26,7 @@ declare class Lead {
|
|
|
26
26
|
* @returns {Promise<Ticket>} - Success response
|
|
27
27
|
* @name createTicket
|
|
28
28
|
* @summary: Creates a ticket
|
|
29
|
-
* @description: Create a new customer support ticket for a user query. - Check out [method documentation](https://
|
|
29
|
+
* @description: Create a new customer support ticket for a user query. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/lead/createTicket/).
|
|
30
30
|
*/
|
|
31
31
|
createTicket({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<Ticket>;
|
|
32
32
|
/**
|
|
@@ -35,7 +35,7 @@ declare class Lead {
|
|
|
35
35
|
* @returns {Promise<CustomForm>} - Success response
|
|
36
36
|
* @name getCustomForm
|
|
37
37
|
* @summary: Get custom form
|
|
38
|
-
* @description: Get a customizable form template for data collection. - Check out [method documentation](https://
|
|
38
|
+
* @description: Get a customizable form template for data collection. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/lead/getCustomForm/).
|
|
39
39
|
*/
|
|
40
40
|
getCustomForm({ slug, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<CustomForm>;
|
|
41
41
|
/**
|
|
@@ -44,7 +44,7 @@ declare class Lead {
|
|
|
44
44
|
* @returns {Promise<Ticket>} - Success response
|
|
45
45
|
* @name getTicket
|
|
46
46
|
* @summary: Get a support ticket
|
|
47
|
-
* @description: Get details of a specific customer support ticket. - Check out [method documentation](https://
|
|
47
|
+
* @description: Get details of a specific customer support ticket. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/lead/getTicket/).
|
|
48
48
|
*/
|
|
49
49
|
getTicket({ id, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<Ticket>;
|
|
50
50
|
/**
|
|
@@ -53,7 +53,7 @@ declare class Lead {
|
|
|
53
53
|
* @returns {Promise<SubmitCustomFormDetails>} - Success response
|
|
54
54
|
* @name submitCustomForm
|
|
55
55
|
* @summary: Submits form data
|
|
56
|
-
* @description: Create user-entered data from a custom form for processing. - Check out [method documentation](https://
|
|
56
|
+
* @description: Create user-entered data from a custom form for processing. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/lead/submitCustomForm/).
|
|
57
57
|
*/
|
|
58
58
|
submitCustomForm({ slug, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<SubmitCustomFormDetails>;
|
|
59
59
|
}
|
|
@@ -40,7 +40,7 @@ class Lead {
|
|
|
40
40
|
* @returns {Promise<TicketHistory>} - Success response
|
|
41
41
|
* @name createHistory
|
|
42
42
|
* @summary: Log ticket history
|
|
43
|
-
* @description: Create a history entry for a specific support ticket. - Check out [method documentation](https://
|
|
43
|
+
* @description: Create a history entry for a specific support ticket. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/lead/createHistory/).
|
|
44
44
|
*/
|
|
45
45
|
async createHistory(
|
|
46
46
|
{ id, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -86,7 +86,7 @@ class Lead {
|
|
|
86
86
|
* @returns {Promise<Ticket>} - Success response
|
|
87
87
|
* @name createTicket
|
|
88
88
|
* @summary: Creates a ticket
|
|
89
|
-
* @description: Create a new customer support ticket for a user query. - Check out [method documentation](https://
|
|
89
|
+
* @description: Create a new customer support ticket for a user query. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/lead/createTicket/).
|
|
90
90
|
*/
|
|
91
91
|
async createTicket(
|
|
92
92
|
{ body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -123,7 +123,7 @@ class Lead {
|
|
|
123
123
|
* @returns {Promise<CustomForm>} - Success response
|
|
124
124
|
* @name getCustomForm
|
|
125
125
|
* @summary: Get custom form
|
|
126
|
-
* @description: Get a customizable form template for data collection. - Check out [method documentation](https://
|
|
126
|
+
* @description: Get a customizable form template for data collection. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/lead/getCustomForm/).
|
|
127
127
|
*/
|
|
128
128
|
async getCustomForm(
|
|
129
129
|
{ slug, requestHeaders } = { requestHeaders: {} },
|
|
@@ -169,7 +169,7 @@ class Lead {
|
|
|
169
169
|
* @returns {Promise<Ticket>} - Success response
|
|
170
170
|
* @name getTicket
|
|
171
171
|
* @summary: Get a support ticket
|
|
172
|
-
* @description: Get details of a specific customer support ticket. - Check out [method documentation](https://
|
|
172
|
+
* @description: Get details of a specific customer support ticket. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/lead/getTicket/).
|
|
173
173
|
*/
|
|
174
174
|
async getTicket(
|
|
175
175
|
{ id, requestHeaders } = { requestHeaders: {} },
|
|
@@ -215,7 +215,7 @@ class Lead {
|
|
|
215
215
|
* @returns {Promise<SubmitCustomFormDetails>} - Success response
|
|
216
216
|
* @name submitCustomForm
|
|
217
217
|
* @summary: Submits form data
|
|
218
|
-
* @description: Create user-entered data from a custom form for processing. - Check out [method documentation](https://
|
|
218
|
+
* @description: Create user-entered data from a custom form for processing. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/lead/submitCustomForm/).
|
|
219
219
|
*/
|
|
220
220
|
async submitCustomForm(
|
|
221
221
|
{ slug, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -8,6 +8,7 @@ declare class Logistic {
|
|
|
8
8
|
getCountry: string;
|
|
9
9
|
getCourierPartners: string;
|
|
10
10
|
getDeliveryPromise: string;
|
|
11
|
+
getFulfillmentOptions: string;
|
|
11
12
|
getLocalities: string;
|
|
12
13
|
getLocality: string;
|
|
13
14
|
getPincodeCity: string;
|
|
@@ -21,7 +22,7 @@ declare class Logistic {
|
|
|
21
22
|
* @returns {Promise<CountryResult>} - Success response
|
|
22
23
|
* @name getAllCountries
|
|
23
24
|
* @summary: Get deliverable countries
|
|
24
|
-
* @description: Get a list of countries within the specified delivery zones for that application. - Check out [method documentation](https://
|
|
25
|
+
* @description: Get a list of countries within the specified delivery zones for that application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getAllCountries/).
|
|
25
26
|
*/
|
|
26
27
|
getAllCountries({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CountryResult>;
|
|
27
28
|
/**
|
|
@@ -30,7 +31,7 @@ declare class Logistic {
|
|
|
30
31
|
* @returns {Promise<GetCountries>} - Success response
|
|
31
32
|
* @name getCountries
|
|
32
33
|
* @summary: Get countries
|
|
33
|
-
* @description: List of supported countries. - Check out [method documentation](https://
|
|
34
|
+
* @description: List of supported countries. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getCountries/).
|
|
34
35
|
*/
|
|
35
36
|
getCountries({ onboarding, pageNo, pageSize, q, hierarchy, phoneCode, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetCountries>;
|
|
36
37
|
/**
|
|
@@ -39,7 +40,7 @@ declare class Logistic {
|
|
|
39
40
|
* @returns {Promise<GetCountry>} - Success response
|
|
40
41
|
* @name getCountry
|
|
41
42
|
* @summary: Get country details
|
|
42
|
-
* @description: Get details about a particular country and its address format customized for different business scenarios. - Check out [method documentation](https://
|
|
43
|
+
* @description: Get details about a particular country and its address format customized for different business scenarios. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getCountry/).
|
|
43
44
|
*/
|
|
44
45
|
getCountry({ countryIsoCode, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<GetCountry>;
|
|
45
46
|
/**
|
|
@@ -48,7 +49,7 @@ declare class Logistic {
|
|
|
48
49
|
* @returns {Promise<ShipmentCourierPartnerResult>} - Success response
|
|
49
50
|
* @name getCourierPartners
|
|
50
51
|
* @summary: Serviceable Courier Partners
|
|
51
|
-
* @description: Get all the serviceable courier partners of a destination and the shipments. - Check out [method documentation](https://
|
|
52
|
+
* @description: Get all the serviceable courier partners of a destination and the shipments. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getCourierPartners/).
|
|
52
53
|
*/
|
|
53
54
|
getCourierPartners({ companyId, applicationId, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ShipmentCourierPartnerResult>;
|
|
54
55
|
/**
|
|
@@ -57,16 +58,25 @@ declare class Logistic {
|
|
|
57
58
|
* @returns {Promise<GetPromiseDetails>} - Success response
|
|
58
59
|
* @name getDeliveryPromise
|
|
59
60
|
* @summary: Get delivery promise
|
|
60
|
-
* @description: Get delivery promises for both global and store levels based on a specific locality type. - Check out [method documentation](https://
|
|
61
|
+
* @description: Get delivery promises for both global and store levels based on a specific locality type. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getDeliveryPromise/).
|
|
61
62
|
*/
|
|
62
63
|
getDeliveryPromise({ xLocationDetail, xApplicationData, pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetPromiseDetails>;
|
|
64
|
+
/**
|
|
65
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
66
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
67
|
+
* @returns {Promise<FulfillmentOptionsList>} - Success response
|
|
68
|
+
* @name getFulfillmentOptions
|
|
69
|
+
* @summary: Get fulfillment options
|
|
70
|
+
* @description: Fetches available fulfillment options. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getFulfillmentOptions/).
|
|
71
|
+
*/
|
|
72
|
+
getFulfillmentOptions({ xApplicationData, productSlug, storeId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<FulfillmentOptionsList>;
|
|
63
73
|
/**
|
|
64
74
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
65
75
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
66
76
|
* @returns {Promise<GetLocalitiesApp>} - Success response
|
|
67
77
|
* @name getLocalities
|
|
68
78
|
* @summary: Get Localities
|
|
69
|
-
* @description: Get Localities data. - Check out [method documentation](https://
|
|
79
|
+
* @description: Get Localities data. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getLocalities/).
|
|
70
80
|
*/
|
|
71
81
|
getLocalities({ localityType, country, state, city, pageNo, pageSize, q, sector, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<GetLocalitiesApp>;
|
|
72
82
|
/**
|
|
@@ -75,7 +85,7 @@ declare class Logistic {
|
|
|
75
85
|
* @returns {Promise<GetLocalityApp>} - Success response
|
|
76
86
|
* @name getLocality
|
|
77
87
|
* @summary: Get Locality API
|
|
78
|
-
* @description: Get 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://
|
|
88
|
+
* @description: Get 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://docs.fynd.com/partners/commerce/sdk/application/logistic/getLocality/).
|
|
79
89
|
*/
|
|
80
90
|
getLocality({ localityType, localityValue, country, state, city, sector, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<GetLocalityApp>;
|
|
81
91
|
/**
|
|
@@ -84,7 +94,7 @@ declare class Logistic {
|
|
|
84
94
|
* @returns {Promise<PincodeDetailsResult>} - Success response
|
|
85
95
|
* @name getPincodeCity
|
|
86
96
|
* @summary: Get pincode details
|
|
87
|
-
* @description: Get details of a specific pincode, such as obtaining its city and state information. - Check out [method documentation](https://
|
|
97
|
+
* @description: Get details of a specific pincode, such as obtaining its city and state information. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getPincodeCity/).
|
|
88
98
|
*/
|
|
89
99
|
getPincodeCity({ pincode, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<PincodeDetailsResult>;
|
|
90
100
|
/**
|
|
@@ -93,7 +103,7 @@ declare class Logistic {
|
|
|
93
103
|
* @returns {Promise<ValidateAddressDetails>} - Success response
|
|
94
104
|
* @name validateAddress
|
|
95
105
|
* @summary: Validate address
|
|
96
|
-
* @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://
|
|
106
|
+
* @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://docs.fynd.com/partners/commerce/sdk/application/logistic/validateAddress/).
|
|
97
107
|
*/
|
|
98
108
|
validateAddress({ countryIsoCode, templateName, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ValidateAddressDetails>;
|
|
99
109
|
}
|
|
@@ -20,6 +20,8 @@ class Logistic {
|
|
|
20
20
|
"/service/application/logistics/v1.0/company/{company_id}/application/{application_id}/shipment/courier-partners",
|
|
21
21
|
getDeliveryPromise:
|
|
22
22
|
"/service/application/logistics/v1.0/delivery-promise",
|
|
23
|
+
getFulfillmentOptions:
|
|
24
|
+
"/service/application/logistics/v1.0/fulfillment-options",
|
|
23
25
|
getLocalities:
|
|
24
26
|
"/service/application/logistics/v1.0/localities/{locality_type}",
|
|
25
27
|
getLocality:
|
|
@@ -50,7 +52,7 @@ class Logistic {
|
|
|
50
52
|
* @returns {Promise<CountryResult>} - Success response
|
|
51
53
|
* @name getAllCountries
|
|
52
54
|
* @summary: Get deliverable countries
|
|
53
|
-
* @description: Get a list of countries within the specified delivery zones for that application. - Check out [method documentation](https://
|
|
55
|
+
* @description: Get a list of countries within the specified delivery zones for that application. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getAllCountries/).
|
|
54
56
|
*/
|
|
55
57
|
async getAllCountries(
|
|
56
58
|
{ requestHeaders } = { requestHeaders: {} },
|
|
@@ -87,7 +89,7 @@ class Logistic {
|
|
|
87
89
|
* @returns {Promise<GetCountries>} - Success response
|
|
88
90
|
* @name getCountries
|
|
89
91
|
* @summary: Get countries
|
|
90
|
-
* @description: List of supported countries. - Check out [method documentation](https://
|
|
92
|
+
* @description: List of supported countries. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getCountries/).
|
|
91
93
|
*/
|
|
92
94
|
async getCountries(
|
|
93
95
|
{
|
|
@@ -138,7 +140,7 @@ class Logistic {
|
|
|
138
140
|
* @returns {Promise<GetCountry>} - Success response
|
|
139
141
|
* @name getCountry
|
|
140
142
|
* @summary: Get country details
|
|
141
|
-
* @description: Get details about a particular country and its address format customized for different business scenarios. - Check out [method documentation](https://
|
|
143
|
+
* @description: Get details about a particular country and its address format customized for different business scenarios. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getCountry/).
|
|
142
144
|
*/
|
|
143
145
|
async getCountry(
|
|
144
146
|
{ countryIsoCode, requestHeaders } = { requestHeaders: {} },
|
|
@@ -184,7 +186,7 @@ class Logistic {
|
|
|
184
186
|
* @returns {Promise<ShipmentCourierPartnerResult>} - Success response
|
|
185
187
|
* @name getCourierPartners
|
|
186
188
|
* @summary: Serviceable Courier Partners
|
|
187
|
-
* @description: Get all the serviceable courier partners of a destination and the shipments. - Check out [method documentation](https://
|
|
189
|
+
* @description: Get all the serviceable courier partners of a destination and the shipments. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getCourierPartners/).
|
|
188
190
|
*/
|
|
189
191
|
async getCourierPartners(
|
|
190
192
|
{ companyId, applicationId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -233,7 +235,7 @@ class Logistic {
|
|
|
233
235
|
* @returns {Promise<GetPromiseDetails>} - Success response
|
|
234
236
|
* @name getDeliveryPromise
|
|
235
237
|
* @summary: Get delivery promise
|
|
236
|
-
* @description: Get delivery promises for both global and store levels based on a specific locality type. - Check out [method documentation](https://
|
|
238
|
+
* @description: Get delivery promises for both global and store levels based on a specific locality type. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getDeliveryPromise/).
|
|
237
239
|
*/
|
|
238
240
|
async getDeliveryPromise(
|
|
239
241
|
{ xLocationDetail, xApplicationData, pageNo, pageSize, requestHeaders } = {
|
|
@@ -270,13 +272,55 @@ class Logistic {
|
|
|
270
272
|
return response;
|
|
271
273
|
}
|
|
272
274
|
|
|
275
|
+
/**
|
|
276
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
277
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
278
|
+
* @returns {Promise<FulfillmentOptionsList>} - Success response
|
|
279
|
+
* @name getFulfillmentOptions
|
|
280
|
+
* @summary: Get fulfillment options
|
|
281
|
+
* @description: Fetches available fulfillment options. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getFulfillmentOptions/).
|
|
282
|
+
*/
|
|
283
|
+
async getFulfillmentOptions(
|
|
284
|
+
{ xApplicationData, productSlug, storeId, requestHeaders } = {
|
|
285
|
+
requestHeaders: {},
|
|
286
|
+
},
|
|
287
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
288
|
+
) {
|
|
289
|
+
const query_params = {};
|
|
290
|
+
query_params["product_slug"] = productSlug;
|
|
291
|
+
query_params["store_id"] = storeId;
|
|
292
|
+
|
|
293
|
+
const xHeaders = {};
|
|
294
|
+
xHeaders["x-application-data"] = xApplicationData;
|
|
295
|
+
|
|
296
|
+
const response = await ApplicationAPIClient.execute(
|
|
297
|
+
this._conf,
|
|
298
|
+
"get",
|
|
299
|
+
constructUrl({
|
|
300
|
+
url: this._urls["getFulfillmentOptions"],
|
|
301
|
+
params: {},
|
|
302
|
+
}),
|
|
303
|
+
query_params,
|
|
304
|
+
undefined,
|
|
305
|
+
{ ...xHeaders, ...requestHeaders },
|
|
306
|
+
{ responseHeaders }
|
|
307
|
+
);
|
|
308
|
+
|
|
309
|
+
let responseData = response;
|
|
310
|
+
if (responseHeaders) {
|
|
311
|
+
responseData = response[0];
|
|
312
|
+
}
|
|
313
|
+
|
|
314
|
+
return response;
|
|
315
|
+
}
|
|
316
|
+
|
|
273
317
|
/**
|
|
274
318
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
275
319
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
276
320
|
* @returns {Promise<GetLocalitiesApp>} - Success response
|
|
277
321
|
* @name getLocalities
|
|
278
322
|
* @summary: Get Localities
|
|
279
|
-
* @description: Get Localities data. - Check out [method documentation](https://
|
|
323
|
+
* @description: Get Localities data. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getLocalities/).
|
|
280
324
|
*/
|
|
281
325
|
async getLocalities(
|
|
282
326
|
{
|
|
@@ -339,7 +383,7 @@ class Logistic {
|
|
|
339
383
|
* @returns {Promise<GetLocalityApp>} - Success response
|
|
340
384
|
* @name getLocality
|
|
341
385
|
* @summary: Get Locality API
|
|
342
|
-
* @description: Get 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://
|
|
386
|
+
* @description: Get 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://docs.fynd.com/partners/commerce/sdk/application/logistic/getLocality/).
|
|
343
387
|
*/
|
|
344
388
|
async getLocality(
|
|
345
389
|
{
|
|
@@ -400,7 +444,7 @@ class Logistic {
|
|
|
400
444
|
* @returns {Promise<PincodeDetailsResult>} - Success response
|
|
401
445
|
* @name getPincodeCity
|
|
402
446
|
* @summary: Get pincode details
|
|
403
|
-
* @description: Get details of a specific pincode, such as obtaining its city and state information. - Check out [method documentation](https://
|
|
447
|
+
* @description: Get details of a specific pincode, such as obtaining its city and state information. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/logistic/getPincodeCity/).
|
|
404
448
|
*/
|
|
405
449
|
async getPincodeCity(
|
|
406
450
|
{ pincode, requestHeaders } = { requestHeaders: {} },
|
|
@@ -446,7 +490,7 @@ class Logistic {
|
|
|
446
490
|
* @returns {Promise<ValidateAddressDetails>} - Success response
|
|
447
491
|
* @name validateAddress
|
|
448
492
|
* @summary: Validate address
|
|
449
|
-
* @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://
|
|
493
|
+
* @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://docs.fynd.com/partners/commerce/sdk/application/logistic/validateAddress/).
|
|
450
494
|
*/
|
|
451
495
|
async validateAddress(
|
|
452
496
|
{ countryIsoCode, templateName, body, requestHeaders } = {
|
|
@@ -24,7 +24,7 @@ declare class Order {
|
|
|
24
24
|
* @returns {Promise<CustomerDetailsResponseSchema>} - Success response
|
|
25
25
|
* @name getCustomerDetailsByShipmentId
|
|
26
26
|
* @summary: Get shipment's customer
|
|
27
|
-
* @description: Get customer details such as mobile number using Shipment ID. - Check out [method documentation](https://
|
|
27
|
+
* @description: Get customer details such as mobile number using Shipment ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getCustomerDetailsByShipmentId/).
|
|
28
28
|
*/
|
|
29
29
|
getCustomerDetailsByShipmentId({ orderId, shipmentId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<CustomerDetailsResponseSchema>;
|
|
30
30
|
/**
|
|
@@ -33,7 +33,7 @@ declare class Order {
|
|
|
33
33
|
* @returns {Promise<ResponseGetInvoiceShipment>} - Success response
|
|
34
34
|
* @name getInvoiceByShipmentId
|
|
35
35
|
* @summary: Retrieves invoice for shipment
|
|
36
|
-
* @description: Get invoice corresponding to a specific shipment ID. - Check out [method documentation](https://
|
|
36
|
+
* @description: Get invoice corresponding to a specific shipment ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getInvoiceByShipmentId/).
|
|
37
37
|
*/
|
|
38
38
|
getInvoiceByShipmentId({ shipmentId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ResponseGetInvoiceShipment>;
|
|
39
39
|
/**
|
|
@@ -42,7 +42,7 @@ declare class Order {
|
|
|
42
42
|
* @returns {Promise<OrderById>} - Success response
|
|
43
43
|
* @name getOrderById
|
|
44
44
|
* @summary: Get an order
|
|
45
|
-
* @description: Get order details such as tracking details, shipment, store information using Fynd Order ID. - Check out [method documentation](https://
|
|
45
|
+
* @description: Get order details such as tracking details, shipment, store information using Fynd Order ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getOrderById/).
|
|
46
46
|
*/
|
|
47
47
|
getOrderById({ orderId, allowInactive, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<OrderById>;
|
|
48
48
|
/**
|
|
@@ -51,7 +51,7 @@ declare class Order {
|
|
|
51
51
|
* @returns {Promise<OrderList>} - Success response
|
|
52
52
|
* @name getOrders
|
|
53
53
|
* @summary: List customer orders
|
|
54
|
-
* @description: Get all orders associated with a customer account. - Check out [method documentation](https://
|
|
54
|
+
* @description: Get all orders associated with a customer account. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getOrders/).
|
|
55
55
|
*/
|
|
56
56
|
getOrders({ status, pageNo, pageSize, fromDate, toDate, startDate, endDate, customMeta, allowInactive, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<OrderList>;
|
|
57
57
|
/**
|
|
@@ -60,7 +60,7 @@ declare class Order {
|
|
|
60
60
|
* @returns {Promise<OrderById>} - Success response
|
|
61
61
|
* @name getPosOrderById
|
|
62
62
|
* @summary: Retrieves POS order details
|
|
63
|
-
* @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://
|
|
63
|
+
* @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://docs.fynd.com/partners/commerce/sdk/application/order/getPosOrderById/).
|
|
64
64
|
*/
|
|
65
65
|
getPosOrderById({ orderId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<OrderById>;
|
|
66
66
|
/**
|
|
@@ -69,7 +69,7 @@ declare class Order {
|
|
|
69
69
|
* @returns {Promise<ShipmentBagReasons>} - Success response
|
|
70
70
|
* @name getShipmentBagReasons
|
|
71
71
|
* @summary: Retrieve Reasons for Cancellation and Return journey
|
|
72
|
-
* @description: Allows users to retrieve a comprehensive list of reasons for cancellation or returning a shipment. It provides both cancellation and return reasons, with an emphasis on Quality Control (QC) evaluations. - Check out [method documentation](https://
|
|
72
|
+
* @description: Allows users to retrieve a comprehensive list of reasons for cancellation or returning a shipment. It provides both cancellation and return reasons, with an emphasis on Quality Control (QC) evaluations. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getShipmentBagReasons/).
|
|
73
73
|
*/
|
|
74
74
|
getShipmentBagReasons({ shipmentId, bagId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ShipmentBagReasons>;
|
|
75
75
|
/**
|
|
@@ -78,7 +78,7 @@ declare class Order {
|
|
|
78
78
|
* @returns {Promise<ShipmentById>} - Success response
|
|
79
79
|
* @name getShipmentById
|
|
80
80
|
* @summary: Get a Shipment
|
|
81
|
-
* @description: Get shipment details such as price breakup, tracking details, store information, etc. using Shipment ID. - Check out [method documentation](https://
|
|
81
|
+
* @description: Get shipment details such as price breakup, tracking details, store information, etc. using Shipment ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getShipmentById/).
|
|
82
82
|
*/
|
|
83
83
|
getShipmentById({ shipmentId, allowInactive, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ShipmentById>;
|
|
84
84
|
/**
|
|
@@ -87,7 +87,7 @@ declare class Order {
|
|
|
87
87
|
* @returns {Promise<ShipmentReasons>} - Success response
|
|
88
88
|
* @name getShipmentReasons
|
|
89
89
|
* @summary: List shipment cancellation reasons
|
|
90
|
-
* @description: Get reasons to perform full or partial cancellation of a shipment. - Check out [method documentation](https://
|
|
90
|
+
* @description: Get reasons to perform full or partial cancellation of a shipment. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getShipmentReasons/).
|
|
91
91
|
*/
|
|
92
92
|
getShipmentReasons({ shipmentId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ShipmentReasons>;
|
|
93
93
|
/**
|
|
@@ -96,7 +96,7 @@ declare class Order {
|
|
|
96
96
|
* @returns {Promise<SendOtpToCustomerResponseSchema>} - Success response
|
|
97
97
|
* @name sendOtpToShipmentCustomer
|
|
98
98
|
* @summary: Send OTP to customer
|
|
99
|
-
* @description: Send OTP to the customer for shipment verification. - Check out [method documentation](https://
|
|
99
|
+
* @description: Send OTP to the customer for shipment verification. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/sendOtpToShipmentCustomer/).
|
|
100
100
|
*/
|
|
101
101
|
sendOtpToShipmentCustomer({ orderId, shipmentId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<SendOtpToCustomerResponseSchema>;
|
|
102
102
|
/**
|
|
@@ -105,7 +105,7 @@ declare class Order {
|
|
|
105
105
|
* @returns {Promise<ShipmentTrack>} - Success response
|
|
106
106
|
* @name trackShipment
|
|
107
107
|
* @summary: Track shipment status
|
|
108
|
-
* @description: Track Shipment by shipment id, for application based on application Id. - Check out [method documentation](https://
|
|
108
|
+
* @description: Track Shipment by shipment id, for application based on application Id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/trackShipment/).
|
|
109
109
|
*/
|
|
110
110
|
trackShipment({ shipmentId, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ShipmentTrack>;
|
|
111
111
|
/**
|
|
@@ -114,7 +114,7 @@ declare class Order {
|
|
|
114
114
|
* @returns {Promise<ShipmentApplicationStatusResponseSchema>} - Success response
|
|
115
115
|
* @name updateShipmentStatus
|
|
116
116
|
* @summary: Updates shipment status
|
|
117
|
-
* @description: This operation allows for updating the status and properties of a shipment. For example, it allows users to initiate a return by providing reasons and uploading quality check images. - Check out [method documentation](https://
|
|
117
|
+
* @description: This operation allows for updating the status and properties of a shipment. For example, it allows users to initiate a return by providing reasons and uploading quality check images. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/updateShipmentStatus/).
|
|
118
118
|
*/
|
|
119
119
|
updateShipmentStatus({ shipmentId, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<ShipmentApplicationStatusResponseSchema>;
|
|
120
120
|
/**
|
|
@@ -123,7 +123,7 @@ declare class Order {
|
|
|
123
123
|
* @returns {Promise<VerifyOtpResponseSchema>} - Success response
|
|
124
124
|
* @name verifyOtpShipmentCustomer
|
|
125
125
|
* @summary: Verifies OTP
|
|
126
|
-
* @description: Verify OTP for getting shipment details - Check out [method documentation](https://
|
|
126
|
+
* @description: Verify OTP for getting shipment details - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/verifyOtpShipmentCustomer/).
|
|
127
127
|
*/
|
|
128
128
|
verifyOtpShipmentCustomer({ orderId, shipmentId, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options, ...args: any[]): Promise<VerifyOtpResponseSchema>;
|
|
129
129
|
}
|
|
@@ -57,7 +57,7 @@ class Order {
|
|
|
57
57
|
* @returns {Promise<CustomerDetailsResponseSchema>} - Success response
|
|
58
58
|
* @name getCustomerDetailsByShipmentId
|
|
59
59
|
* @summary: Get shipment's customer
|
|
60
|
-
* @description: Get customer details such as mobile number using Shipment ID. - Check out [method documentation](https://
|
|
60
|
+
* @description: Get customer details such as mobile number using Shipment ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getCustomerDetailsByShipmentId/).
|
|
61
61
|
*/
|
|
62
62
|
async getCustomerDetailsByShipmentId(
|
|
63
63
|
{ orderId, shipmentId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -106,7 +106,7 @@ class Order {
|
|
|
106
106
|
* @returns {Promise<ResponseGetInvoiceShipment>} - Success response
|
|
107
107
|
* @name getInvoiceByShipmentId
|
|
108
108
|
* @summary: Retrieves invoice for shipment
|
|
109
|
-
* @description: Get invoice corresponding to a specific shipment ID. - Check out [method documentation](https://
|
|
109
|
+
* @description: Get invoice corresponding to a specific shipment ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getInvoiceByShipmentId/).
|
|
110
110
|
*/
|
|
111
111
|
async getInvoiceByShipmentId(
|
|
112
112
|
{ shipmentId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -152,7 +152,7 @@ class Order {
|
|
|
152
152
|
* @returns {Promise<OrderById>} - Success response
|
|
153
153
|
* @name getOrderById
|
|
154
154
|
* @summary: Get an order
|
|
155
|
-
* @description: Get order details such as tracking details, shipment, store information using Fynd Order ID. - Check out [method documentation](https://
|
|
155
|
+
* @description: Get order details such as tracking details, shipment, store information using Fynd Order ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getOrderById/).
|
|
156
156
|
*/
|
|
157
157
|
async getOrderById(
|
|
158
158
|
{ orderId, allowInactive, requestHeaders } = { requestHeaders: {} },
|
|
@@ -199,7 +199,7 @@ class Order {
|
|
|
199
199
|
* @returns {Promise<OrderList>} - Success response
|
|
200
200
|
* @name getOrders
|
|
201
201
|
* @summary: List customer orders
|
|
202
|
-
* @description: Get all orders associated with a customer account. - Check out [method documentation](https://
|
|
202
|
+
* @description: Get all orders associated with a customer account. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getOrders/).
|
|
203
203
|
*/
|
|
204
204
|
async getOrders(
|
|
205
205
|
{
|
|
@@ -256,7 +256,7 @@ class Order {
|
|
|
256
256
|
* @returns {Promise<OrderById>} - Success response
|
|
257
257
|
* @name getPosOrderById
|
|
258
258
|
* @summary: Retrieves POS order details
|
|
259
|
-
* @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://
|
|
259
|
+
* @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://docs.fynd.com/partners/commerce/sdk/application/order/getPosOrderById/).
|
|
260
260
|
*/
|
|
261
261
|
async getPosOrderById(
|
|
262
262
|
{ orderId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -302,7 +302,7 @@ class Order {
|
|
|
302
302
|
* @returns {Promise<ShipmentBagReasons>} - Success response
|
|
303
303
|
* @name getShipmentBagReasons
|
|
304
304
|
* @summary: Retrieve Reasons for Cancellation and Return journey
|
|
305
|
-
* @description: Allows users to retrieve a comprehensive list of reasons for cancellation or returning a shipment. It provides both cancellation and return reasons, with an emphasis on Quality Control (QC) evaluations. - Check out [method documentation](https://
|
|
305
|
+
* @description: Allows users to retrieve a comprehensive list of reasons for cancellation or returning a shipment. It provides both cancellation and return reasons, with an emphasis on Quality Control (QC) evaluations. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getShipmentBagReasons/).
|
|
306
306
|
*/
|
|
307
307
|
async getShipmentBagReasons(
|
|
308
308
|
{ shipmentId, bagId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -351,7 +351,7 @@ class Order {
|
|
|
351
351
|
* @returns {Promise<ShipmentById>} - Success response
|
|
352
352
|
* @name getShipmentById
|
|
353
353
|
* @summary: Get a Shipment
|
|
354
|
-
* @description: Get shipment details such as price breakup, tracking details, store information, etc. using Shipment ID. - Check out [method documentation](https://
|
|
354
|
+
* @description: Get shipment details such as price breakup, tracking details, store information, etc. using Shipment ID. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getShipmentById/).
|
|
355
355
|
*/
|
|
356
356
|
async getShipmentById(
|
|
357
357
|
{ shipmentId, allowInactive, requestHeaders } = { requestHeaders: {} },
|
|
@@ -398,7 +398,7 @@ class Order {
|
|
|
398
398
|
* @returns {Promise<ShipmentReasons>} - Success response
|
|
399
399
|
* @name getShipmentReasons
|
|
400
400
|
* @summary: List shipment cancellation reasons
|
|
401
|
-
* @description: Get reasons to perform full or partial cancellation of a shipment. - Check out [method documentation](https://
|
|
401
|
+
* @description: Get reasons to perform full or partial cancellation of a shipment. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/getShipmentReasons/).
|
|
402
402
|
*/
|
|
403
403
|
async getShipmentReasons(
|
|
404
404
|
{ shipmentId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -444,7 +444,7 @@ class Order {
|
|
|
444
444
|
* @returns {Promise<SendOtpToCustomerResponseSchema>} - Success response
|
|
445
445
|
* @name sendOtpToShipmentCustomer
|
|
446
446
|
* @summary: Send OTP to customer
|
|
447
|
-
* @description: Send OTP to the customer for shipment verification. - Check out [method documentation](https://
|
|
447
|
+
* @description: Send OTP to the customer for shipment verification. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/sendOtpToShipmentCustomer/).
|
|
448
448
|
*/
|
|
449
449
|
async sendOtpToShipmentCustomer(
|
|
450
450
|
{ orderId, shipmentId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -493,7 +493,7 @@ class Order {
|
|
|
493
493
|
* @returns {Promise<ShipmentTrack>} - Success response
|
|
494
494
|
* @name trackShipment
|
|
495
495
|
* @summary: Track shipment status
|
|
496
|
-
* @description: Track Shipment by shipment id, for application based on application Id. - Check out [method documentation](https://
|
|
496
|
+
* @description: Track Shipment by shipment id, for application based on application Id. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/trackShipment/).
|
|
497
497
|
*/
|
|
498
498
|
async trackShipment(
|
|
499
499
|
{ shipmentId, requestHeaders } = { requestHeaders: {} },
|
|
@@ -539,7 +539,7 @@ class Order {
|
|
|
539
539
|
* @returns {Promise<ShipmentApplicationStatusResponseSchema>} - Success response
|
|
540
540
|
* @name updateShipmentStatus
|
|
541
541
|
* @summary: Updates shipment status
|
|
542
|
-
* @description: This operation allows for updating the status and properties of a shipment. For example, it allows users to initiate a return by providing reasons and uploading quality check images. - Check out [method documentation](https://
|
|
542
|
+
* @description: This operation allows for updating the status and properties of a shipment. For example, it allows users to initiate a return by providing reasons and uploading quality check images. - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/updateShipmentStatus/).
|
|
543
543
|
*/
|
|
544
544
|
async updateShipmentStatus(
|
|
545
545
|
{ shipmentId, body, requestHeaders } = { requestHeaders: {} },
|
|
@@ -585,7 +585,7 @@ class Order {
|
|
|
585
585
|
* @returns {Promise<VerifyOtpResponseSchema>} - Success response
|
|
586
586
|
* @name verifyOtpShipmentCustomer
|
|
587
587
|
* @summary: Verifies OTP
|
|
588
|
-
* @description: Verify OTP for getting shipment details - Check out [method documentation](https://
|
|
588
|
+
* @description: Verify OTP for getting shipment details - Check out [method documentation](https://docs.fynd.com/partners/commerce/sdk/application/order/verifyOtpShipmentCustomer/).
|
|
589
589
|
*/
|
|
590
590
|
async verifyOtpShipmentCustomer(
|
|
591
591
|
{ orderId, shipmentId, body, requestHeaders } = { requestHeaders: {} },
|