@gofynd/fdk-client-javascript 1.4.15-beta.6 → 1.4.16-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/package.json +1 -1
- package/sdk/application/ApplicationClient.d.ts +2 -0
- package/sdk/application/ApplicationClient.js +2 -0
- package/sdk/application/Cart/CartApplicationClient.d.ts +68 -48
- package/sdk/application/Cart/CartApplicationClient.js +130 -27
- package/sdk/application/Catalog/CatalogApplicationClient.d.ts +59 -58
- package/sdk/application/Catalog/CatalogApplicationClient.js +30 -29
- package/sdk/application/Common/CommonApplicationClient.d.ts +2 -2
- package/sdk/application/Common/CommonApplicationClient.js +1 -1
- package/sdk/application/Configuration/ConfigurationApplicationClient.d.ts +20 -20
- package/sdk/application/Configuration/ConfigurationApplicationClient.js +10 -10
- package/sdk/application/Content/ContentApplicationClient.d.ts +19 -30
- package/sdk/application/Content/ContentApplicationClient.js +40 -60
- package/sdk/application/FileStorage/FileStorageApplicationClient.d.ts +8 -8
- package/sdk/application/FileStorage/FileStorageApplicationClient.js +7 -7
- package/sdk/application/Finance/FinanceApplicationClient.d.ts +29 -0
- package/sdk/application/Finance/FinanceApplicationClient.js +126 -0
- package/sdk/application/Lead/LeadApplicationClient.d.ts +2 -2
- package/sdk/application/Lead/LeadApplicationClient.js +1 -1
- package/sdk/application/Logistic/LogisticApplicationClient.d.ts +35 -15
- package/sdk/application/Logistic/LogisticApplicationClient.js +118 -8
- package/sdk/application/Order/OrderApplicationClient.d.ts +22 -12
- package/sdk/application/Order/OrderApplicationClient.js +62 -8
- package/sdk/application/Payment/PaymentApplicationClient.d.ts +87 -87
- package/sdk/application/Payment/PaymentApplicationClient.js +65 -46
- package/sdk/application/Rewards/RewardsApplicationClient.d.ts +13 -13
- package/sdk/application/Rewards/RewardsApplicationClient.js +7 -7
- package/sdk/application/Theme/ThemeApplicationClient.d.ts +2 -2
- package/sdk/application/Theme/ThemeApplicationClient.js +4 -2
- package/sdk/application/User/UserApplicationClient.d.ts +10 -10
- package/sdk/application/User/UserApplicationClient.js +6 -6
- package/sdk/application/Webhook/WebhookApplicationClient.d.ts +4 -4
- package/sdk/application/Webhook/WebhookApplicationClient.js +3 -3
- package/sdk/partner/FileStorage/FileStoragePartnerClient.d.ts +86 -12
- package/sdk/partner/FileStorage/FileStoragePartnerClient.js +582 -24
- package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts +116 -19
- package/sdk/partner/FileStorage/FileStoragePartnerModel.js +121 -14
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts +8 -1
- package/sdk/partner/FileStorage/FileStoragePartnerValidator.js +51 -4
- package/sdk/partner/Lead/LeadPartnerClient.d.ts +2 -2
- package/sdk/partner/Lead/LeadPartnerClient.js +2 -2
- package/sdk/partner/Lead/LeadPartnerModel.d.ts +5 -5
- package/sdk/partner/Lead/LeadPartnerModel.js +15 -15
- package/sdk/partner/Logistics/LogisticsPartnerClient.d.ts +126 -20
- package/sdk/partner/Logistics/LogisticsPartnerClient.js +970 -20
- package/sdk/partner/Logistics/LogisticsPartnerModel.d.ts +1200 -167
- package/sdk/partner/Logistics/LogisticsPartnerModel.js +571 -160
- package/sdk/partner/Logistics/LogisticsPartnerValidator.d.ts +10 -0
- package/sdk/partner/Logistics/LogisticsPartnerValidator.js +121 -7
- package/sdk/partner/Theme/ThemePartnerClient.d.ts +8 -10
- package/sdk/partner/Theme/ThemePartnerClient.js +14 -16
- package/sdk/partner/Theme/ThemePartnerModel.d.ts +96 -37
- package/sdk/partner/Theme/ThemePartnerModel.js +90 -36
- package/sdk/partner/Theme/ThemePartnerValidator.js +4 -4
- package/sdk/partner/Webhook/WebhookPartnerClient.d.ts +28 -18
- package/sdk/partner/Webhook/WebhookPartnerClient.js +103 -18
- package/sdk/partner/Webhook/WebhookPartnerModel.d.ts +612 -179
- package/sdk/partner/Webhook/WebhookPartnerModel.js +253 -150
- package/sdk/partner/Webhook/WebhookPartnerValidator.d.ts +1 -0
- package/sdk/partner/Webhook/WebhookPartnerValidator.js +11 -3
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.d.ts +5 -4
- package/sdk/platform/Analytics/AnalyticsPlatformApplicationClient.js +14 -8
- package/sdk/platform/Analytics/AnalyticsPlatformModel.d.ts +59 -9
- package/sdk/platform/Analytics/AnalyticsPlatformModel.js +40 -4
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.d.ts +2 -32
- package/sdk/platform/AuditTrail/AuditTrailPlatformClient.js +3 -243
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.d.ts +11 -130
- package/sdk/platform/AuditTrail/AuditTrailPlatformModel.js +12 -152
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.d.ts +1 -39
- package/sdk/platform/AuditTrail/AuditTrailPlatformValidator.js +0 -35
- package/sdk/platform/Billing/BillingPlatformClient.d.ts +12 -12
- package/sdk/platform/Billing/BillingPlatformClient.js +15 -15
- package/sdk/platform/Billing/BillingPlatformModel.d.ts +443 -388
- package/sdk/platform/Billing/BillingPlatformModel.js +280 -263
- package/sdk/platform/Billing/BillingPlatformValidator.d.ts +16 -18
- package/sdk/platform/Billing/BillingPlatformValidator.js +8 -9
- package/sdk/platform/Cart/CartPlatformApplicationClient.d.ts +134 -103
- package/sdk/platform/Cart/CartPlatformApplicationClient.js +419 -115
- package/sdk/platform/Cart/CartPlatformApplicationValidator.d.ts +121 -65
- package/sdk/platform/Cart/CartPlatformApplicationValidator.js +109 -44
- package/sdk/platform/Cart/CartPlatformModel.d.ts +5039 -1300
- package/sdk/platform/Cart/CartPlatformModel.js +1976 -1217
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.d.ts +209 -183
- package/sdk/platform/Catalog/CatalogPlatformApplicationClient.js +452 -395
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.d.ts +185 -142
- package/sdk/platform/Catalog/CatalogPlatformApplicationValidator.js +96 -78
- package/sdk/platform/Catalog/CatalogPlatformClient.d.ts +154 -117
- package/sdk/platform/Catalog/CatalogPlatformClient.js +292 -172
- package/sdk/platform/Catalog/CatalogPlatformModel.d.ts +6941 -2203
- package/sdk/platform/Catalog/CatalogPlatformModel.js +3224 -1687
- package/sdk/platform/Catalog/CatalogPlatformValidator.d.ts +72 -31
- package/sdk/platform/Catalog/CatalogPlatformValidator.js +50 -24
- package/sdk/platform/Common/CommonPlatformClient.d.ts +3 -2
- package/sdk/platform/Common/CommonPlatformClient.js +3 -2
- package/sdk/platform/Common/CommonPlatformModel.d.ts +9 -9
- package/sdk/platform/Common/CommonPlatformModel.js +6 -6
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.d.ts +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationClient.js +16 -17
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.d.ts +8 -8
- package/sdk/platform/Communication/CommunicationPlatformApplicationValidator.js +8 -8
- package/sdk/platform/Communication/CommunicationPlatformModel.d.ts +43 -33
- package/sdk/platform/Communication/CommunicationPlatformModel.js +38 -34
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.d.ts +46 -42
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformClient.js +47 -43
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.d.ts +223 -223
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformModel.js +210 -212
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.d.ts +12 -12
- package/sdk/platform/CompanyProfile/CompanyProfilePlatformValidator.js +12 -12
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.d.ts +46 -33
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationClient.js +67 -54
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.d.ts +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformApplicationValidator.js +18 -18
- package/sdk/platform/Configuration/ConfigurationPlatformClient.d.ts +45 -24
- package/sdk/platform/Configuration/ConfigurationPlatformClient.js +134 -30
- package/sdk/platform/Configuration/ConfigurationPlatformModel.d.ts +283 -124
- package/sdk/platform/Configuration/ConfigurationPlatformModel.js +219 -94
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.d.ts +37 -9
- package/sdk/platform/Configuration/ConfigurationPlatformValidator.js +27 -8
- package/sdk/platform/Content/ContentPlatformApplicationClient.d.ts +124 -141
- package/sdk/platform/Content/ContentPlatformApplicationClient.js +449 -422
- package/sdk/platform/Content/ContentPlatformApplicationValidator.d.ts +179 -141
- package/sdk/platform/Content/ContentPlatformApplicationValidator.js +168 -130
- package/sdk/platform/Content/ContentPlatformClient.d.ts +142 -106
- package/sdk/platform/Content/ContentPlatformClient.js +523 -336
- package/sdk/platform/Content/ContentPlatformModel.d.ts +1241 -395
- package/sdk/platform/Content/ContentPlatformModel.js +521 -390
- package/sdk/platform/Content/ContentPlatformValidator.d.ts +168 -117
- package/sdk/platform/Content/ContentPlatformValidator.js +162 -108
- package/sdk/platform/Discount/DiscountPlatformClient.d.ts +14 -12
- package/sdk/platform/Discount/DiscountPlatformClient.js +14 -12
- package/sdk/platform/Discount/DiscountPlatformModel.d.ts +13 -13
- package/sdk/platform/Discount/DiscountPlatformModel.js +12 -12
- package/sdk/platform/Discount/DiscountPlatformValidator.d.ts +2 -2
- package/sdk/platform/Discount/DiscountPlatformValidator.js +2 -2
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.d.ts +94 -36
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationClient.js +462 -60
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.d.ts +62 -15
- package/sdk/platform/FileStorage/FileStoragePlatformApplicationValidator.js +75 -13
- package/sdk/platform/FileStorage/FileStoragePlatformClient.d.ts +19 -19
- package/sdk/platform/FileStorage/FileStoragePlatformClient.js +21 -21
- package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts +370 -101
- package/sdk/platform/FileStorage/FileStoragePlatformModel.js +313 -84
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.d.ts +6 -6
- package/sdk/platform/FileStorage/FileStoragePlatformValidator.js +6 -6
- package/sdk/platform/Lead/LeadPlatformClient.d.ts +2 -2
- package/sdk/platform/Lead/LeadPlatformClient.js +2 -2
- package/sdk/platform/Lead/LeadPlatformModel.d.ts +5 -5
- package/sdk/platform/Lead/LeadPlatformModel.js +16 -16
- package/sdk/platform/Order/OrderPlatformApplicationClient.d.ts +17 -6
- package/sdk/platform/Order/OrderPlatformApplicationClient.js +85 -7
- package/sdk/platform/Order/OrderPlatformApplicationValidator.d.ts +95 -24
- package/sdk/platform/Order/OrderPlatformApplicationValidator.js +39 -19
- package/sdk/platform/Order/OrderPlatformClient.d.ts +153 -96
- package/sdk/platform/Order/OrderPlatformClient.js +416 -198
- package/sdk/platform/Order/OrderPlatformModel.d.ts +7602 -1269
- package/sdk/platform/Order/OrderPlatformModel.js +3926 -1269
- package/sdk/platform/Order/OrderPlatformValidator.d.ts +270 -109
- package/sdk/platform/Order/OrderPlatformValidator.js +135 -77
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.d.ts +6 -4
- package/sdk/platform/Partner/PartnerPlatformApplicationClient.js +9 -7
- package/sdk/platform/Partner/PartnerPlatformModel.d.ts +9 -9
- package/sdk/platform/Partner/PartnerPlatformModel.js +8 -8
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.d.ts +93 -105
- package/sdk/platform/Payment/PaymentPlatformApplicationClient.js +129 -141
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.d.ts +48 -48
- package/sdk/platform/Payment/PaymentPlatformApplicationValidator.js +48 -48
- package/sdk/platform/Payment/PaymentPlatformClient.d.ts +20 -20
- package/sdk/platform/Payment/PaymentPlatformClient.js +20 -20
- package/sdk/platform/Payment/PaymentPlatformModel.d.ts +333 -319
- package/sdk/platform/Payment/PaymentPlatformModel.js +288 -278
- package/sdk/platform/Payment/PaymentPlatformValidator.d.ts +8 -8
- package/sdk/platform/Payment/PaymentPlatformValidator.js +8 -8
- package/sdk/platform/PlatformClient.d.ts +0 -2
- package/sdk/platform/PlatformClient.js +0 -4
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationClient.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/Rewards/RewardsPlatformApplicationValidator.js +2 -2
- package/sdk/platform/Rewards/RewardsPlatformModel.d.ts +9 -9
- package/sdk/platform/Rewards/RewardsPlatformModel.js +8 -8
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.d.ts +48 -38
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationClient.js +134 -43
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.d.ts +46 -17
- package/sdk/platform/Serviceability/ServiceabilityPlatformApplicationValidator.js +34 -14
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.d.ts +38 -44
- package/sdk/platform/Serviceability/ServiceabilityPlatformClient.js +56 -62
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.d.ts +1842 -609
- package/sdk/platform/Serviceability/ServiceabilityPlatformModel.js +886 -554
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.d.ts +42 -46
- package/sdk/platform/Serviceability/ServiceabilityPlatformValidator.js +26 -28
- package/sdk/platform/Share/SharePlatformApplicationClient.d.ts +2 -2
- package/sdk/platform/Share/SharePlatformApplicationClient.js +2 -2
- package/sdk/platform/Share/SharePlatformModel.d.ts +36 -5
- package/sdk/platform/Share/SharePlatformModel.js +27 -4
- package/sdk/platform/Theme/ThemePlatformApplicationClient.d.ts +3 -3
- package/sdk/platform/Theme/ThemePlatformApplicationClient.js +8 -4
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.d.ts +5 -0
- package/sdk/platform/Theme/ThemePlatformApplicationValidator.js +2 -0
- package/sdk/platform/Theme/ThemePlatformModel.d.ts +37 -11
- package/sdk/platform/Theme/ThemePlatformModel.js +33 -15
- package/sdk/platform/User/UserPlatformApplicationClient.d.ts +12 -12
- package/sdk/platform/User/UserPlatformApplicationClient.js +12 -12
- package/sdk/platform/User/UserPlatformApplicationValidator.d.ts +2 -2
- package/sdk/platform/User/UserPlatformApplicationValidator.js +2 -2
- package/sdk/platform/User/UserPlatformModel.d.ts +21 -21
- package/sdk/platform/User/UserPlatformModel.js +23 -23
- package/sdk/platform/Webhook/WebhookPlatformClient.d.ts +25 -78
- package/sdk/platform/Webhook/WebhookPlatformClient.js +75 -470
- package/sdk/platform/Webhook/WebhookPlatformModel.d.ts +720 -427
- package/sdk/platform/Webhook/WebhookPlatformModel.js +410 -386
- package/sdk/platform/Webhook/WebhookPlatformValidator.d.ts +10 -55
- package/sdk/platform/Webhook/WebhookPlatformValidator.js +12 -72
- package/sdk/platform/index.d.ts +0 -1
- package/sdk/platform/index.js +0 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.d.ts +3 -2
- package/sdk/public/Configuration/ConfigurationPublicClient.js +6 -5
- package/sdk/public/Configuration/ConfigurationPublicModel.d.ts +9 -9
- package/sdk/public/Configuration/ConfigurationPublicModel.js +6 -6
- package/sdk/public/Content/ContentPublicClient.d.ts +112 -2
- package/sdk/public/Content/ContentPublicClient.js +895 -8
- package/sdk/public/Content/ContentPublicModel.d.ts +549 -3
- package/sdk/public/Content/ContentPublicModel.js +649 -3
- package/sdk/public/Content/ContentPublicValidator.d.ts +69 -3
- package/sdk/public/Content/ContentPublicValidator.js +88 -2
- package/sdk/public/Webhook/WebhookPublicClient.d.ts +8 -8
- package/sdk/public/Webhook/WebhookPublicClient.js +8 -8
- package/sdk/public/Webhook/WebhookPublicModel.d.ts +21 -21
- package/sdk/public/Webhook/WebhookPublicModel.js +15 -15
- package/sdk/public/Webhook/WebhookPublicValidator.d.ts +4 -4
- package/sdk/public/Webhook/WebhookPublicValidator.js +4 -4
- package/sdk/platform/Finance/FinancePlatformClient.d.ts +0 -320
- package/sdk/platform/Finance/FinancePlatformClient.js +0 -2333
- package/sdk/platform/Finance/FinancePlatformModel.d.ts +0 -2890
- package/sdk/platform/Finance/FinancePlatformModel.js +0 -2148
- package/sdk/platform/Finance/FinancePlatformValidator.d.ts +0 -284
- package/sdk/platform/Finance/FinancePlatformValidator.js +0 -354
|
@@ -13,11 +13,11 @@ class Content {
|
|
|
13
13
|
this._relativeUrls = {
|
|
14
14
|
getAnnouncements: "/service/application/content/v1.0/announcements",
|
|
15
15
|
getBlog: "/service/application/content/v1.0/blogs/{slug}",
|
|
16
|
-
getBlogs: "/service/application/content/v1.0/blogs
|
|
17
|
-
|
|
18
|
-
"/service/application/content/
|
|
19
|
-
|
|
20
|
-
"/service/application/content/
|
|
16
|
+
getBlogs: "/service/application/content/v1.0/blogs",
|
|
17
|
+
getCustomFieldsByResourceId:
|
|
18
|
+
"/service/application/content/v2.0/customfields/resource/{resource}/{resource_slug}",
|
|
19
|
+
getCustomObjectBySlug:
|
|
20
|
+
"/service/application/content/v2.0/customobjects/definition/{definition_slug}/entries/{slug}",
|
|
21
21
|
getDataLoaders: "/service/application/content/v1.0/data-loader",
|
|
22
22
|
getFaqBySlug: "/service/application/content/v1.0/faq/{slug}",
|
|
23
23
|
getFaqCategories: "/service/application/content/v1.0/faq/categories",
|
|
@@ -28,13 +28,13 @@ class Content {
|
|
|
28
28
|
"/service/application/content/v1.0/faq/category/{slug}/faqs",
|
|
29
29
|
getLandingPage: "/service/application/content/v1.0/landing-page",
|
|
30
30
|
getLegalInformation: "/service/application/content/v1.0/legal",
|
|
31
|
-
getNavigations: "/service/application/content/v1.0/navigations
|
|
31
|
+
getNavigations: "/service/application/content/v1.0/navigations",
|
|
32
32
|
getPage: "/service/application/content/v2.0/pages/{slug}",
|
|
33
|
-
getPages: "/service/application/content/v2.0/pages
|
|
33
|
+
getPages: "/service/application/content/v2.0/pages",
|
|
34
34
|
getSEOConfiguration: "/service/application/content/v1.0/seo",
|
|
35
35
|
getSEOMarkupSchemas: "/service/application/content/v1.0/seo/schema",
|
|
36
36
|
getSlideshow: "/service/application/content/v1.0/slideshow/{slug}",
|
|
37
|
-
getSlideshows: "/service/application/content/v1.0/slideshow
|
|
37
|
+
getSlideshows: "/service/application/content/v1.0/slideshow",
|
|
38
38
|
getSupportInformation: "/service/application/content/v1.0/support",
|
|
39
39
|
getTags: "/service/application/content/v1.0/tags",
|
|
40
40
|
};
|
|
@@ -108,7 +108,7 @@ class Content {
|
|
|
108
108
|
* @description: Get information related to a specific blog such as it's contents, author, publish date, SEO related information. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getBlog/).
|
|
109
109
|
*/
|
|
110
110
|
async getBlog(
|
|
111
|
-
{ slug, rootId, requestHeaders } = { requestHeaders: {} },
|
|
111
|
+
{ slug, rootId, preview, requestHeaders } = { requestHeaders: {} },
|
|
112
112
|
{ responseHeaders } = { responseHeaders: false }
|
|
113
113
|
) {
|
|
114
114
|
let invalidInput = [];
|
|
@@ -128,6 +128,7 @@ class Content {
|
|
|
128
128
|
|
|
129
129
|
const query_params = {};
|
|
130
130
|
query_params["root_id"] = rootId;
|
|
131
|
+
query_params["preview"] = preview;
|
|
131
132
|
|
|
132
133
|
const xHeaders = {};
|
|
133
134
|
|
|
@@ -155,7 +156,7 @@ class Content {
|
|
|
155
156
|
/**
|
|
156
157
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
157
158
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
158
|
-
* @returns {Promise<
|
|
159
|
+
* @returns {Promise<BlogGetDetails>} - Success response
|
|
159
160
|
* @name getBlogs
|
|
160
161
|
* @summary: List blogs
|
|
161
162
|
* @description: List all the blogs against an application. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getBlogs/).
|
|
@@ -205,12 +206,12 @@ class Content {
|
|
|
205
206
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
206
207
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
207
208
|
* @returns {Promise<CustomFieldsResponseByResourceIdSchema>} - Success response
|
|
208
|
-
* @name
|
|
209
|
-
* @summary: Get list of custom fields
|
|
210
|
-
* @description:
|
|
209
|
+
* @name getCustomFieldsByResourceId
|
|
210
|
+
* @summary: Get list of custom fields of given resource and resource slug
|
|
211
|
+
* @description: Retrieves a list of custom fields attached to a particular resource by using the resource and resource slug. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomFieldsByResourceId/).
|
|
211
212
|
*/
|
|
212
|
-
async
|
|
213
|
-
{ resource,
|
|
213
|
+
async getCustomFieldsByResourceId(
|
|
214
|
+
{ resource, resourceSlug, requestHeaders } = { requestHeaders: {} },
|
|
214
215
|
{ responseHeaders } = { responseHeaders: false }
|
|
215
216
|
) {
|
|
216
217
|
let invalidInput = [];
|
|
@@ -221,10 +222,10 @@ class Content {
|
|
|
221
222
|
path: ["resource"],
|
|
222
223
|
});
|
|
223
224
|
}
|
|
224
|
-
if (!
|
|
225
|
+
if (!resourceSlug) {
|
|
225
226
|
invalidInput.push({
|
|
226
|
-
message: `The '
|
|
227
|
-
path: ["
|
|
227
|
+
message: `The 'resourceSlug' field is required.`,
|
|
228
|
+
path: ["resourceSlug"],
|
|
228
229
|
});
|
|
229
230
|
}
|
|
230
231
|
if (invalidInput.length) {
|
|
@@ -242,8 +243,8 @@ class Content {
|
|
|
242
243
|
this._conf,
|
|
243
244
|
"get",
|
|
244
245
|
constructUrl({
|
|
245
|
-
url: this._urls["
|
|
246
|
-
params: { resource,
|
|
246
|
+
url: this._urls["getCustomFieldsByResourceId"],
|
|
247
|
+
params: { resource, resourceSlug },
|
|
247
248
|
}),
|
|
248
249
|
query_params,
|
|
249
250
|
undefined,
|
|
@@ -263,20 +264,26 @@ class Content {
|
|
|
263
264
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
264
265
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
265
266
|
* @returns {Promise<CustomObjectByIdSchema>} - Success response
|
|
266
|
-
* @name
|
|
267
|
-
* @summary: Get custom object
|
|
268
|
-
* @description:
|
|
267
|
+
* @name getCustomObjectBySlug
|
|
268
|
+
* @summary: Get custom object details
|
|
269
|
+
* @description: Details of a custom object entry can be obtained using this endpoint. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getCustomObjectBySlug/).
|
|
269
270
|
*/
|
|
270
|
-
async
|
|
271
|
-
{
|
|
271
|
+
async getCustomObjectBySlug(
|
|
272
|
+
{ definitionSlug, slug, requestHeaders } = { requestHeaders: {} },
|
|
272
273
|
{ responseHeaders } = { responseHeaders: false }
|
|
273
274
|
) {
|
|
274
275
|
let invalidInput = [];
|
|
275
276
|
|
|
276
|
-
if (!
|
|
277
|
+
if (!definitionSlug) {
|
|
278
|
+
invalidInput.push({
|
|
279
|
+
message: `The 'definitionSlug' field is required.`,
|
|
280
|
+
path: ["definitionSlug"],
|
|
281
|
+
});
|
|
282
|
+
}
|
|
283
|
+
if (!slug) {
|
|
277
284
|
invalidInput.push({
|
|
278
|
-
message: `The '
|
|
279
|
-
path: ["
|
|
285
|
+
message: `The 'slug' field is required.`,
|
|
286
|
+
path: ["slug"],
|
|
280
287
|
});
|
|
281
288
|
}
|
|
282
289
|
if (invalidInput.length) {
|
|
@@ -294,8 +301,8 @@ class Content {
|
|
|
294
301
|
this._conf,
|
|
295
302
|
"get",
|
|
296
303
|
constructUrl({
|
|
297
|
-
url: this._urls["
|
|
298
|
-
params: {
|
|
304
|
+
url: this._urls["getCustomObjectBySlug"],
|
|
305
|
+
params: { definitionSlug, slug },
|
|
299
306
|
}),
|
|
300
307
|
query_params,
|
|
301
308
|
undefined,
|
|
@@ -695,7 +702,7 @@ class Content {
|
|
|
695
702
|
/**
|
|
696
703
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
697
704
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
698
|
-
* @returns {Promise<
|
|
705
|
+
* @returns {Promise<NavigationGetDetails>} - Success response
|
|
699
706
|
* @name getNavigations
|
|
700
707
|
* @summary: List navigation items
|
|
701
708
|
* @description: Get the navigation link items which can be powered to generate menus on application's website or equivalent mobile apps. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getNavigations/).
|
|
@@ -795,7 +802,7 @@ class Content {
|
|
|
795
802
|
/**
|
|
796
803
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
797
804
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
798
|
-
* @returns {Promise<
|
|
805
|
+
* @returns {Promise<PageGetDetails>} - Success response
|
|
799
806
|
* @name getPages
|
|
800
807
|
* @summary: Lists pages
|
|
801
808
|
* @description: Lists all Custom Pages. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getPages/).
|
|
@@ -986,7 +993,7 @@ class Content {
|
|
|
986
993
|
/**
|
|
987
994
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
988
995
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
989
|
-
* @returns {Promise<
|
|
996
|
+
* @returns {Promise<SlideshowGetDetails>} - Success response
|
|
990
997
|
* @name getSlideshows
|
|
991
998
|
* @summary: List Slideshows
|
|
992
999
|
* @description: List slideshows along with their details. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/content/getSlideshows/).
|
|
@@ -1030,33 +1037,6 @@ class Content {
|
|
|
1030
1037
|
return response;
|
|
1031
1038
|
}
|
|
1032
1039
|
|
|
1033
|
-
/**
|
|
1034
|
-
* @param {Object} arg - Arg object.
|
|
1035
|
-
* @param {number} [arg.pageSize] - The number of items to retrieve in each page.
|
|
1036
|
-
* @returns {Paginator<SlideshowGetResponse>}
|
|
1037
|
-
* @summary: List Slideshows
|
|
1038
|
-
* @description: List slideshows along with their details.
|
|
1039
|
-
*/
|
|
1040
|
-
getSlideshowsPaginator({ pageSize } = {}) {
|
|
1041
|
-
const paginator = new Paginator();
|
|
1042
|
-
const callback = async () => {
|
|
1043
|
-
const pageId = paginator.nextId;
|
|
1044
|
-
const pageNo = paginator.pageNo;
|
|
1045
|
-
const pageType = "number";
|
|
1046
|
-
const data = await this.getSlideshows({
|
|
1047
|
-
pageNo: pageNo,
|
|
1048
|
-
pageSize: pageSize,
|
|
1049
|
-
});
|
|
1050
|
-
paginator.setPaginator({
|
|
1051
|
-
hasNext: data.page.has_next ? true : false,
|
|
1052
|
-
nextId: data.page.next_id,
|
|
1053
|
-
});
|
|
1054
|
-
return data;
|
|
1055
|
-
};
|
|
1056
|
-
paginator.setCallback(callback.bind(this));
|
|
1057
|
-
return paginator;
|
|
1058
|
-
}
|
|
1059
|
-
|
|
1060
1040
|
/**
|
|
1061
1041
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
1062
1042
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -12,30 +12,30 @@ declare class FileStorage {
|
|
|
12
12
|
/**
|
|
13
13
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
14
14
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
15
|
-
* @returns {Promise<
|
|
15
|
+
* @returns {Promise<FileUploadComplete>} - Success response
|
|
16
16
|
* @name completeUpload
|
|
17
|
-
* @summary:
|
|
17
|
+
* @summary: Finalizes upload process.
|
|
18
18
|
* @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://partners.fynd.com/help/docs/sdk/application/filestorage/completeUpload/).
|
|
19
19
|
*/
|
|
20
|
-
completeUpload({ namespace, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
20
|
+
completeUpload({ namespace, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<FileUploadComplete>;
|
|
21
21
|
/**
|
|
22
22
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
23
23
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
24
|
-
* @returns {Promise<
|
|
24
|
+
* @returns {Promise<SignUrlResult>} - Success response
|
|
25
25
|
* @name signUrls
|
|
26
|
-
* @summary:
|
|
26
|
+
* @summary: Signs file URLs.
|
|
27
27
|
* @description: Generates secure, signed URLs that is valid for certain expiry time for accessing stored files. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/signUrls/).
|
|
28
28
|
*/
|
|
29
|
-
signUrls({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
29
|
+
signUrls({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SignUrlResult>;
|
|
30
30
|
/**
|
|
31
31
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
32
32
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
33
|
-
* @returns {Promise<
|
|
33
|
+
* @returns {Promise<FileUpload>} - Success response
|
|
34
34
|
* @name startUpload
|
|
35
35
|
* @summary: Initiates file upload
|
|
36
36
|
* @description: Starts the process of uploading a file to storage location, and returns a signed url in response. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/startUpload/).
|
|
37
37
|
*/
|
|
38
|
-
startUpload({ namespace, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
38
|
+
startUpload({ namespace, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<FileUpload>;
|
|
39
39
|
/**
|
|
40
40
|
* @param data
|
|
41
41
|
* @param {string} file_name
|
|
@@ -14,10 +14,10 @@ class FileStorage {
|
|
|
14
14
|
this._conf = _conf;
|
|
15
15
|
this._relativeUrls = {
|
|
16
16
|
completeUpload:
|
|
17
|
-
"/service/application/assets/
|
|
17
|
+
"/service/application/assets/v2.0/namespaces/{namespace}/upload/complete",
|
|
18
18
|
signUrls: "/service/application/assets/v1.0/sign-urls",
|
|
19
19
|
startUpload:
|
|
20
|
-
"/service/application/assets/
|
|
20
|
+
"/service/application/assets/v2.0/namespaces/{namespace}/upload/start",
|
|
21
21
|
};
|
|
22
22
|
this._urls = Object.entries(this._relativeUrls).reduce(
|
|
23
23
|
(urls, [method, relativeUrl]) => {
|
|
@@ -38,9 +38,9 @@ class FileStorage {
|
|
|
38
38
|
/**
|
|
39
39
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
40
40
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
41
|
-
* @returns {Promise<
|
|
41
|
+
* @returns {Promise<FileUploadComplete>} - Success response
|
|
42
42
|
* @name completeUpload
|
|
43
|
-
* @summary:
|
|
43
|
+
* @summary: Finalizes upload process.
|
|
44
44
|
* @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://partners.fynd.com/help/docs/sdk/application/filestorage/completeUpload/).
|
|
45
45
|
*/
|
|
46
46
|
async completeUpload(
|
|
@@ -90,9 +90,9 @@ class FileStorage {
|
|
|
90
90
|
/**
|
|
91
91
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
92
92
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
93
|
-
* @returns {Promise<
|
|
93
|
+
* @returns {Promise<SignUrlResult>} - Success response
|
|
94
94
|
* @name signUrls
|
|
95
|
-
* @summary:
|
|
95
|
+
* @summary: Signs file URLs.
|
|
96
96
|
* @description: Generates secure, signed URLs that is valid for certain expiry time for accessing stored files. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/signUrls/).
|
|
97
97
|
*/
|
|
98
98
|
async signUrls(
|
|
@@ -135,7 +135,7 @@ class FileStorage {
|
|
|
135
135
|
/**
|
|
136
136
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
137
137
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
138
|
-
* @returns {Promise<
|
|
138
|
+
* @returns {Promise<FileUpload>} - Success response
|
|
139
139
|
* @name startUpload
|
|
140
140
|
* @summary: Initiates file upload
|
|
141
141
|
* @description: Starts the process of uploading a file to storage location, and returns a signed url in response. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/filestorage/startUpload/).
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
export = Finance;
|
|
2
|
+
declare class Finance {
|
|
3
|
+
constructor(_conf: any);
|
|
4
|
+
_conf: any;
|
|
5
|
+
_relativeUrls: {
|
|
6
|
+
customerCreditBalance: string;
|
|
7
|
+
lockUnlockCreditNote: string;
|
|
8
|
+
};
|
|
9
|
+
_urls: {};
|
|
10
|
+
updateUrls(urls: any): void;
|
|
11
|
+
/**
|
|
12
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
13
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
14
|
+
* @returns {Promise<CustomerCreditBalanceResponseSchema>} - Success response
|
|
15
|
+
* @name customerCreditBalance
|
|
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://partners.fynd.com/help/docs/sdk/application/finance/customerCreditBalance/).
|
|
18
|
+
*/
|
|
19
|
+
customerCreditBalance({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CustomerCreditBalanceResponseSchema>;
|
|
20
|
+
/**
|
|
21
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
22
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
23
|
+
* @returns {Promise<LockUnlockResponseSchema>} - Success response
|
|
24
|
+
* @name lockUnlockCreditNote
|
|
25
|
+
* @summary: Lock or Unlock requested credit note.
|
|
26
|
+
* @description: Used to lock or unlock requested credit note. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/finance/lockUnlockCreditNote/).
|
|
27
|
+
*/
|
|
28
|
+
lockUnlockCreditNote({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<LockUnlockResponseSchema>;
|
|
29
|
+
}
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
const {
|
|
2
|
+
FDKClientValidationError,
|
|
3
|
+
FDKResponseValidationError,
|
|
4
|
+
} = require("../../common/FDKError");
|
|
5
|
+
|
|
6
|
+
const ApplicationAPIClient = require("../ApplicationAPIClient");
|
|
7
|
+
const constructUrl = require("../constructUrl");
|
|
8
|
+
const Paginator = require("../../common/Paginator");
|
|
9
|
+
|
|
10
|
+
class Finance {
|
|
11
|
+
constructor(_conf) {
|
|
12
|
+
this._conf = _conf;
|
|
13
|
+
this._relativeUrls = {
|
|
14
|
+
customerCreditBalance:
|
|
15
|
+
"/service/application/finance/v1.0/customer-credit-balance",
|
|
16
|
+
lockUnlockCreditNote:
|
|
17
|
+
"/service/application/finance/v1.0/lock-unlock-credit-note",
|
|
18
|
+
};
|
|
19
|
+
this._urls = Object.entries(this._relativeUrls).reduce(
|
|
20
|
+
(urls, [method, relativeUrl]) => {
|
|
21
|
+
urls[method] = `${_conf.domain}${relativeUrl}`;
|
|
22
|
+
return urls;
|
|
23
|
+
},
|
|
24
|
+
{}
|
|
25
|
+
);
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
updateUrls(urls) {
|
|
29
|
+
this._urls = {
|
|
30
|
+
...this._urls,
|
|
31
|
+
...urls,
|
|
32
|
+
};
|
|
33
|
+
}
|
|
34
|
+
|
|
35
|
+
/**
|
|
36
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
37
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
38
|
+
* @returns {Promise<CustomerCreditBalanceResponseSchema>} - Success response
|
|
39
|
+
* @name customerCreditBalance
|
|
40
|
+
* @summary: This API will provide customer's credit balance against phone number or email and seller*affiliate id
|
|
41
|
+
* @description: This API will provide customer's credit balance against phone number or email and seller*affiliate id - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/finance/customerCreditBalance/).
|
|
42
|
+
*/
|
|
43
|
+
async customerCreditBalance(
|
|
44
|
+
{ body, requestHeaders } = { requestHeaders: {} },
|
|
45
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
46
|
+
) {
|
|
47
|
+
let invalidInput = [];
|
|
48
|
+
if (invalidInput.length) {
|
|
49
|
+
const error = new Error();
|
|
50
|
+
error.message = "Missing required field";
|
|
51
|
+
error.details = invalidInput;
|
|
52
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
53
|
+
}
|
|
54
|
+
|
|
55
|
+
const query_params = {};
|
|
56
|
+
|
|
57
|
+
const xHeaders = {};
|
|
58
|
+
|
|
59
|
+
const response = await ApplicationAPIClient.execute(
|
|
60
|
+
this._conf,
|
|
61
|
+
"post",
|
|
62
|
+
constructUrl({
|
|
63
|
+
url: this._urls["customerCreditBalance"],
|
|
64
|
+
params: {},
|
|
65
|
+
}),
|
|
66
|
+
query_params,
|
|
67
|
+
body,
|
|
68
|
+
{ ...xHeaders, ...requestHeaders },
|
|
69
|
+
{ responseHeaders }
|
|
70
|
+
);
|
|
71
|
+
|
|
72
|
+
let responseData = response;
|
|
73
|
+
if (responseHeaders) {
|
|
74
|
+
responseData = response[0];
|
|
75
|
+
}
|
|
76
|
+
|
|
77
|
+
return response;
|
|
78
|
+
}
|
|
79
|
+
|
|
80
|
+
/**
|
|
81
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
82
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
83
|
+
* @returns {Promise<LockUnlockResponseSchema>} - Success response
|
|
84
|
+
* @name lockUnlockCreditNote
|
|
85
|
+
* @summary: Lock or Unlock requested credit note.
|
|
86
|
+
* @description: Used to lock or unlock requested credit note. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/finance/lockUnlockCreditNote/).
|
|
87
|
+
*/
|
|
88
|
+
async lockUnlockCreditNote(
|
|
89
|
+
{ body, requestHeaders } = { requestHeaders: {} },
|
|
90
|
+
{ responseHeaders } = { responseHeaders: false }
|
|
91
|
+
) {
|
|
92
|
+
let invalidInput = [];
|
|
93
|
+
if (invalidInput.length) {
|
|
94
|
+
const error = new Error();
|
|
95
|
+
error.message = "Missing required field";
|
|
96
|
+
error.details = invalidInput;
|
|
97
|
+
return Promise.reject(new FDKClientValidationError(error));
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
const query_params = {};
|
|
101
|
+
|
|
102
|
+
const xHeaders = {};
|
|
103
|
+
|
|
104
|
+
const response = await ApplicationAPIClient.execute(
|
|
105
|
+
this._conf,
|
|
106
|
+
"post",
|
|
107
|
+
constructUrl({
|
|
108
|
+
url: this._urls["lockUnlockCreditNote"],
|
|
109
|
+
params: {},
|
|
110
|
+
}),
|
|
111
|
+
query_params,
|
|
112
|
+
body,
|
|
113
|
+
{ ...xHeaders, ...requestHeaders },
|
|
114
|
+
{ responseHeaders }
|
|
115
|
+
);
|
|
116
|
+
|
|
117
|
+
let responseData = response;
|
|
118
|
+
if (responseHeaders) {
|
|
119
|
+
responseData = response[0];
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
return response;
|
|
123
|
+
}
|
|
124
|
+
}
|
|
125
|
+
|
|
126
|
+
module.exports = Finance;
|
|
@@ -50,10 +50,10 @@ declare class Lead {
|
|
|
50
50
|
/**
|
|
51
51
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
52
52
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
53
|
-
* @returns {Promise<
|
|
53
|
+
* @returns {Promise<SubmitCustomFormDetails>} - Success response
|
|
54
54
|
* @name submitCustomForm
|
|
55
55
|
* @summary: Submits form data
|
|
56
56
|
* @description: Create user-entered data from a custom form for processing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/submitCustomForm/).
|
|
57
57
|
*/
|
|
58
|
-
submitCustomForm({ slug, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
58
|
+
submitCustomForm({ slug, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<SubmitCustomFormDetails>;
|
|
59
59
|
}
|
|
@@ -237,7 +237,7 @@ class Lead {
|
|
|
237
237
|
/**
|
|
238
238
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
239
239
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
240
|
-
* @returns {Promise<
|
|
240
|
+
* @returns {Promise<SubmitCustomFormDetails>} - Success response
|
|
241
241
|
* @name submitCustomForm
|
|
242
242
|
* @summary: Submits form data
|
|
243
243
|
* @description: Create user-entered data from a custom form for processing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/submitCustomForm/).
|
|
@@ -6,6 +6,8 @@ declare class Logistic {
|
|
|
6
6
|
getAllCountries: string;
|
|
7
7
|
getCountries: string;
|
|
8
8
|
getCountry: string;
|
|
9
|
+
getCourierPartners: string;
|
|
10
|
+
getDeliveryPromise: string;
|
|
9
11
|
getLocalities: string;
|
|
10
12
|
getLocality: string;
|
|
11
13
|
getLocations: string;
|
|
@@ -20,12 +22,12 @@ declare class Logistic {
|
|
|
20
22
|
/**
|
|
21
23
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
22
24
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
23
|
-
* @returns {Promise<
|
|
25
|
+
* @returns {Promise<CountryListResult>} - Success response
|
|
24
26
|
* @name getAllCountries
|
|
25
27
|
* @summary: Get deliverable countries
|
|
26
28
|
* @description: Get 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/).
|
|
27
29
|
*/
|
|
28
|
-
getAllCountries({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
30
|
+
getAllCountries({ requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<CountryListResult>;
|
|
29
31
|
/**
|
|
30
32
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
31
33
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -34,7 +36,7 @@ declare class Logistic {
|
|
|
34
36
|
* @summary: Get countries
|
|
35
37
|
* @description: List of supported countries. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCountries/).
|
|
36
38
|
*/
|
|
37
|
-
getCountries({ onboarding, pageNo, pageSize, q, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetCountries>;
|
|
39
|
+
getCountries({ onboarding, pageNo, pageSize, q, hierarchy, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetCountries>;
|
|
38
40
|
/**
|
|
39
41
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
40
42
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -44,6 +46,24 @@ declare class Logistic {
|
|
|
44
46
|
* @description: Get 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/).
|
|
45
47
|
*/
|
|
46
48
|
getCountry({ countryIsoCode, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetCountry>;
|
|
49
|
+
/**
|
|
50
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
51
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
52
|
+
* @returns {Promise<ShipmentCourierPartnerResult>} - Success response
|
|
53
|
+
* @name getCourierPartners
|
|
54
|
+
* @summary: Serviceable Courier Partners.
|
|
55
|
+
* @description: Get all the serviceable courier partners of a destination and the shipments. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getCourierPartners/).
|
|
56
|
+
*/
|
|
57
|
+
getCourierPartners({ companyId, applicationId, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ShipmentCourierPartnerResult>;
|
|
58
|
+
/**
|
|
59
|
+
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
60
|
+
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
61
|
+
* @returns {Promise<GetPromiseDetails>} - Success response
|
|
62
|
+
* @name getDeliveryPromise
|
|
63
|
+
* @summary: Get delivery promise
|
|
64
|
+
* @description: Get delivery promises for both global and store levels based on a specific locality type. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getDeliveryPromise/).
|
|
65
|
+
*/
|
|
66
|
+
getDeliveryPromise({ pageNo, pageSize, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetPromiseDetails>;
|
|
47
67
|
/**
|
|
48
68
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
49
69
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
@@ -65,55 +85,55 @@ declare class Logistic {
|
|
|
65
85
|
/**
|
|
66
86
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
67
87
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
68
|
-
* @returns {Promise<
|
|
88
|
+
* @returns {Promise<GetStoreResult>} - Success response
|
|
69
89
|
* @name getLocations
|
|
70
90
|
* @summary: Get available selling locations
|
|
71
91
|
* @description: Get 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/).
|
|
72
92
|
*/
|
|
73
|
-
getLocations({ xApplicationId, xApplicationData, country, state, city, pincode, sector, pageNo, pageSize, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
93
|
+
getLocations({ xApplicationId, xApplicationData, country, state, city, pincode, sector, pageNo, pageSize, requestHeaders, }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetStoreResult>;
|
|
74
94
|
/**
|
|
75
95
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
76
96
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
77
|
-
* @returns {Promise<
|
|
97
|
+
* @returns {Promise<ReAssignStoreResult>} - Success response
|
|
78
98
|
* @name getOptimalLocations
|
|
79
99
|
* @summary: Get selling locations
|
|
80
100
|
* @description: Get optimal fulfillment centre 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/).
|
|
81
101
|
*/
|
|
82
|
-
getOptimalLocations({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
102
|
+
getOptimalLocations({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ReAssignStoreResult>;
|
|
83
103
|
/**
|
|
84
104
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
85
105
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
86
|
-
* @returns {Promise<
|
|
106
|
+
* @returns {Promise<PincodeDetails>} - Success response
|
|
87
107
|
* @name getPincodeCity
|
|
88
108
|
* @summary: Get pincode details
|
|
89
109
|
* @description: Get 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/).
|
|
90
110
|
*/
|
|
91
|
-
getPincodeCity({ pincode, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
111
|
+
getPincodeCity({ pincode, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<PincodeDetails>;
|
|
92
112
|
/**
|
|
93
113
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
94
114
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
95
|
-
* @returns {Promise<
|
|
115
|
+
* @returns {Promise<GetZoneFromPincodeViewResult>} - Success response
|
|
96
116
|
* @name getPincodeZones
|
|
97
117
|
* @summary: Get zones
|
|
98
118
|
* @description: Get the delivery zone associated with a given pincode. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeZones/).
|
|
99
119
|
*/
|
|
100
|
-
getPincodeZones({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
120
|
+
getPincodeZones({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<GetZoneFromPincodeViewResult>;
|
|
101
121
|
/**
|
|
102
122
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
103
123
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
104
|
-
* @returns {Promise<
|
|
124
|
+
* @returns {Promise<TATViewResult>} - Success response
|
|
105
125
|
* @name getTatProduct
|
|
106
126
|
* @summary: Get product's turnaround time
|
|
107
127
|
* @description: Get the estimated delivery time frame for a specific product from a designated store. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getTatProduct/).
|
|
108
128
|
*/
|
|
109
|
-
getTatProduct({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
129
|
+
getTatProduct({ body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<TATViewResult>;
|
|
110
130
|
/**
|
|
111
131
|
* @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
|
|
112
132
|
* @param {import("../ApplicationAPIClient").Options} - Options
|
|
113
|
-
* @returns {Promise<
|
|
133
|
+
* @returns {Promise<ValidateAddressDetails>} - Success response
|
|
114
134
|
* @name validateAddress
|
|
115
135
|
* @summary: Validate address
|
|
116
136
|
* @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/).
|
|
117
137
|
*/
|
|
118
|
-
validateAddress({ countryIsoCode, templateName, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<
|
|
138
|
+
validateAddress({ countryIsoCode, templateName, body, requestHeaders }?: object, { responseHeaders }?: import("../ApplicationAPIClient").Options): Promise<ValidateAddressDetails>;
|
|
119
139
|
}
|